rspec-scaffold 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 51b15bd17f15c8ded617f732b63b29b839091124
-  data.tar.gz: 5cf8d3cd2aa8b584667c7ac49833682b378b1075
+SHA256:
+  metadata.gz: 9a2a7871e4122aa2bbb9b421f6ec0e9c052de7a560550b3117db1452487a3def
+  data.tar.gz: 8a4a4ae6cd7246bb3c6621296c4d6f8a0ca4f38285924dea526d8c313112df83
 SHA512:
-  metadata.gz: 04bbf347bcf64103ccfa680ee78514d1d455b9d698d51dec3272413513074a9aaf5204851e1cda559fc27404391134a5233fdf8a717d8a9e11e7fbd3e62c291d
-  data.tar.gz: 07f52b0f041b1ce612627ac453c35d18d538ba9bf20d6801aeea1a441d8ab1b95a4b206d19700a26f39fc401c6fab82006f737d96744b1d8bb17f66547d26ea2
+  metadata.gz: 59f66d34054bbb192f1d9e20c30e2af2c2570e0c105b63f8825c843fb8db052fc70903778a1b8d8e4ee52a8f45e85aa6c0b118655756e7d10eaa2588ef081aa6
+  data.tar.gz: c6cbe0d841a9ca2466ebff5f6a74340a020bd3810eb3a5495556facbba74c60d915e0ee783a3b2d4d87a3b65eff5eca7f3323f7225a8ba3e67f445b467e16e1e

data/.gitignore

@@ -9,3 +9,4 @@
 /tmp/
 *.gem
 .byebug_history
+.idea

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

data/.ruby-version

@@ -1 +1 @@
-ruby-2.2.2
+ruby-2.7.8

data/.travis.yml

@@ -1,7 +1,4 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.2.1
-  - 2.2.2
-  - 2.2.3
-before_install: gem install bundler -v 1.10.4
+  - 2.7.8
+before_install: gem install bundler

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [2.0.0.beta1] - 2017-05-12
+### Added
+- Convenience methods `RSpec::Scaffold.testify_file` and `RSpec::Scaffold.testify_text` which allow making scaffolds from within code.
+- rspec-scaffold CLI
+
+### Changed
+- Scaffolds no longer produce the 'require spec/rails_helper' line - devs should keep it in .rspec file.
+- Updates to Rails controller scaffolds
+- Updates to Rails Model scaffolds
+
+## [1.0.0] - 2016-08-05
+Core functionality, `rake rspec:scaffold[app/models/ability.rb]`.  

data/Gemfile

@@ -3,8 +3,6 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in rspec-scaffold.gemspec
 gemspec
 
-gem 'byebug' if RUBY_VERSION >= '2.0.0'
-
 group :test do
   gem 'rake' # for ogb TravisCI
   gem 'rspec-core', '~> 3'

data/README.md

@@ -1,22 +1,74 @@
-# RSpec Scaffolding [![Build Status](https://travis-ci.org/ridiculous/rspec-scaffold.svg)](https://travis-ci.org/ridiculous/rspec-scaffold)
+# RSpec Scaffold [![Gem Version](https://badge.fury.io/rb/rspec-scaffold.svg)](https://badge.fury.io/rb/rspec-scaffold)
 
-Generates RSpec scaffolding for existing code. Helps you write tests by showing you what you should be testing, 
-which are conditions and changes to state (at a minimum).
+Generates RSpec scaffolding for existing code.  
+Cleverly infers spec location from source file location.   
+Helps you write tests by showing you what you should be testing, which are conditions and changes to state (at a minimum).
 
 ## Installation
 
 Requires Ruby >= 1.9.3
 
+__1. update gemfile and bundle__
+
 ```ruby
-gem 'rspec-scaffold'
+gem 'rspec-scaffold', '~> 2.0.0.beta1', require: false
+```
+
+__2. see if it works__
+
+```
+rspec-scaffold
 ```
 
+## Caveats
+Works best if used from within a Rails app root and if the project has the spec/ directory (it should!).  
+
 ## Usage
+The gem provides a command line utility `rspec-scaffold` for working with existing files, and simple-to-use module methods for programmatic use.  
+The idea is to point to existing ruby code files and `rspec-scaffold` will ensure corresponding spec files in `/spec` directory.  
+
+### The CLI
+Only handles files/directories. If you want to feed in raw code, use the module methods.  
 
-Takes either a file or a directory.
+__file in -> file out__
 
 ```bash
-rake rspec:scaffold[lib]
+rspec-scaffold "path/to/code.rb"
+```
+
+__directory in -> files out__
+
+```bash
+# pass -y option to pre-agree to many spec file creation
+rspec-scaffold "app/models/"
+```
+
+__output to STDOUT instead of file__
+
+```bash
+rspec-scaffold -t "path/to/code.rb"  
+```
+
+### The methods
+
+Three scenarios are supported:
+
+__1. Provide ruby code -> get scaffold string (not supported by CLI since it would be cumbersome)__
+
+```rb
+RSpec::Scaffold.testify_text(text)  
+```
+
+__2. Provide ruby code file(s) -> get scaffold string__
+
+```rb
+RSpec::Scaffold.testify_file(filepath, :to_text)
+```
+
+__3. Provide ruby code file(s) -> get scaffold file(s)__
+
+```rb
+RSpec::Scaffold.testify_file(filepath, out: "/optional/custom/output/file.rb")  
 ```
 
 ## Example
@@ -42,39 +94,45 @@ end
 ```
 
 ```bash
-rake rspec:scaffold[app/models/ability.rb]
+rspec-scaffold "app/models/ability.rb"
 ```
 
-Outputs:
+Outputs to 'spec/models/ability_spec.rb':
 
 ```ruby
-# spec/models/ability_spec.rb
-require "spec_helper"
-
-describe Ability do
+# rspec spec/models/ability_spec.rb
+describe Ability, type: :model do
+  klass = Ability
   let(:user) {}
 
-  subject { described_class.new user }
-
   describe "#initialize" do
     context "when user.admin?" do
-      before {}
+      xit "should " do
+        expect(0).to eq 1
+      end
     end
 
     context "unless user.admin?" do
-      before {}
+      xit "should " do
+        expect(0).to eq 1
+      end
     end
   end
+
 end
 ```
 
+## TODO
+* Have scaffolds be aware of method arguments, especially keyword ones.  
+* Have concern scaffolds output which module it is they are for.  
+* Have concern scaffolds recognize methods defined within `module ClassMethods` as class methods.  
+
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 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).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rspec-scaffold.
-
+Bug reports and pull requests are welcome on GitHub at https://github.com/ridiculous/rspec-scaffold.

data/Rakefile

@@ -1,3 +1,4 @@
+require 'rake/release'
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec) do |config|

data/exe/rspec-scaffold

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'rspec/scaffold'
+RSpec::Scaffold::Cli.new(Pathname(`pwd`.strip)).start

data/lib/rspec/scaffold/cli.rb

@@ -0,0 +1,161 @@
+module RSpec
+  module Scaffold
+    class Cli
+      # This class handles `rspec=scaffold` command runs from command line.
+
+      # this method allows simple testing since it, unlike ARGV constant, can be mocked.
+      def self.command_line_arguments
+        return ARGV # => ["-t", "-y", "/some/path"] or ["-ty", "/some/path"]
+      end
+
+      # @param [Pathname] boot_path
+      def initialize(boot_path)
+        @boot_path = boot_path
+        @command_line_arguments = send(:class).command_line_arguments
+      end
+
+      # This method will be run as a script and uses on ARGV hash contents
+      def start
+        # fallback to help text output if needed args are missing
+        (puts help_string; abort) if path_argument.nil? || options.include?("h")
+
+        # 0 see if path argument is not absolute
+        (puts absolute_path_warning; abort) if path_argument[%r'\A[\/]']
+
+        # 0. see if passed file/dir exists and is in boot_path tree.
+        (puts not_found_warning_string; abort) if !file_or_dir.exist?
+
+        # 1. must process path argument to determine whether it is a single file or a dir.
+        @processable_files = if file_or_dir.directory?
+          RSpec::Scaffold::DirExpander.new(file_or_dir).expand_ruby_files
+        else
+          # file_or_dir.file?
+          [file_or_dir]
+        end
+
+        # 2. verify processing if there are numerous files and -y is not given
+        if !many_processable_file_danger? || argumented_agreeing? || output_to_console?
+          # noop, alls well
+        else
+          puts "#{@processable_files.size} files are about to be processed. Are you sure? [Y/n]"
+          if STDIN.gets.strip[%r'\Ay'i]
+            green("-> Proceeding with scaffold build!")
+          else
+            abort("Nothing was done!")
+          end
+        end
+
+        # 2. once path processing is done, array of files (sometimes and array of one file) is looped over
+        @processable_files.each do |processable_file|
+          # all is set for processing
+          if output_to_console?
+            test_scaffold = RSpec::Scaffold.testify_file(processable_file, :to_text)
+
+            puts("#== #{processable_file} ==")
+            puts("")
+            puts(test_scaffold)
+            puts("")
+          else
+            # build found file's spec file location
+            spec_file_location = RSpec::Scaffold::SpecLocationBuilder.new(@boot_path, processable_file).spec_location
+
+            # output to spec files, core behavior
+            RSpec::Scaffold.testify_file(processable_file, out: spec_file_location)
+          end
+        end
+
+        puts "-> All done!"
+
+        return true
+      end
+
+      private
+
+        self::OPTIONS = {
+          "--help" => "h",
+          "--text" => "t",
+        }.freeze
+
+        def options
+          @options ||= @command_line_arguments.select{|arg| arg[0] == "-" && arg.size > 1}.map do |arg|
+            if !!arg == true && arg[1] != "-"
+              # unpack several singledash options
+              arg.split("")[1..-1]
+            else
+              # making doubledash options into singledash
+              send(:class)::OPTIONS[arg]
+            end
+          end.flatten.uniq.join("")
+
+          return @options #=> "hty"
+        end
+
+        def argumented_agreeing?
+          return options.include?("y")
+        end
+
+        def output_to_console?
+          return options.include?("t")
+        end
+
+        def many_processable_file_danger?
+          return 5 < @processable_files.size
+        end
+
+        def path_argument
+          @path_argument ||= (!!@command_line_arguments[-1] == true && @command_line_arguments[-1][0] != "-" ? @command_line_arguments[-1] : nil)
+
+          return @path_argument
+        end
+
+        def file_or_dir
+          return nil if path_argument.nil?
+
+          @file_or_dir ||= findable_pathname
+
+          return @file_or_dir
+        end
+
+        def findable_pathname
+          return @findable_pathname ||= Pathname("#{@boot_path}").join("#{path_argument}")
+        end
+
+        def help_string
+          help_string = <<-ENDBAR
+Build RSpec tests scaffolds for existing ruby code.
+
+Usage:
+  rspec-scaffold <options> PATH
+
+Available options:
+  -h, --help Prints this message
+  -t, --text Outputs scaffold(s) to STDOUT instead of spec files
+
+Common use cases:
+  1) file in -> file out | rspec-scaffold "path/to/code.rb"
+  2) directory in -> files out | rspec-scaffold "path/to/code/directory"
+  3) output to STDOUT instead of files | rspec-scaffold -t "path/to/code.rb"
+          ENDBAR
+
+          return help_string.strip.gsub(%r'\A\s+', '')
+        end
+
+        def not_found_warning_string
+          warning_string = <<-ENDBAR
+Could not find "#{findable_pathname}"
+          ENDBAR
+
+          return warning_string.strip.gsub(%r'\A\s+', '')
+        end
+
+        def absolute_path_warning
+          warning_string = <<-ENDBAR
+Absolute path argument '#{path_argument}' detected. Please use a relative path (no leading slash) from project root.
+          ENDBAR
+
+          return warning_string.strip.gsub(%r'\A\s+', '')
+        end
+
+    end
+  end
+end

data/lib/rspec/scaffold/dir_expander.rb

@@ -0,0 +1,28 @@
+module RSpec
+  module Scaffold
+    class DirExpander
+      # manages recursively finding ruby files in directories.
+
+      # @param [Pathname] input_dir
+      def initialize(input_dir)
+        @input_dir = Pathname(input_dir)
+      end
+
+      # RSpec::Scaffold::DirExpander.new("/path/to/dir")
+      def expand_ruby_files
+        # 1. Raise if not a directory
+        raise(ArgumentError.new(%Q|"#{file}" is not a directory|)) if !@input_dir.directory?
+
+        # 2. do the expansion of ruby files
+        print ">> scanning #{@input_dir} tree for ruby files... "
+
+        @ruby_files_in_tree ||= Dir.glob("#{@input_dir.to_s.gsub(%r'/\z', '')}/**/*.rb")
+
+        puts "done"
+
+        return @ruby_files_in_tree #=> ["/rspec-scaffold/spec/dummy/app/lib/some_service_class.rb"] array of strings
+      end
+
+    end
+  end
+end

data/lib/rspec/scaffold/file_writer.rb

@@ -0,0 +1,39 @@
+module RSpec
+  module Scaffold
+    class FileWriter
+      # manages outputting test scaffolds to file.
+
+      def initialize(output_file, output_text)
+        @output_file = Pathname(output_file)
+        @output_text = output_text
+      end
+
+      # RSpec::Scaffold::FileWriter.new("/path/to/file.rb", "yay, test scaffold!")
+      def write!
+        # 1. skip if file already exists.
+        if output_file_already_exists?
+          RSpec::Scaffold.log("- #{@output_file} - already exists", :puts)
+          return
+        end
+
+        # 2. ensure parent directories exist
+        FileUtils.makedirs(@output_file.parent)
+
+        # 3. write to file
+        File.open(@output_file, 'wb') do |f| # 'wb' originally
+          f << @output_text
+        end
+
+        RSpec::Scaffold.log("+ #{@output_file}")
+
+        return @output_file.to_s
+      end
+
+      private
+        def output_file_already_exists?
+          return @exists ||= @output_file.exist?
+        end
+
+    end
+  end
+end

data/lib/rspec/scaffold/generator.rb

@@ -1,36 +1,57 @@
 module RSpec
   module Scaffold
-    class Generator < DelegateClass(Ryan)
+    class Generator
+      # Generates an array of lines that can be joined into an RSpec file based.
+      #
+      # @param [Ryan,#name,#funcs,#initialization_args,#class?,#module?] parser object that is used to build the rspec file
 
-      # = Class
-      # generate a rspec file based on existing code
-
-      attr_reader :file
-
-      def initialize(file)
-        @file = file
-        super Ryan.new(file)
+      def initialize(parser)
+        @parser = parser
       end
 
-      def const
-        @const ||= name.split('::').inject(Kernel) { |k, part| k.const_get part }
-      end
+      def perform(parser=nil)
+        # for backwards compat with arg to perform
+        @parser = (parser.nil? ? @parser : parser)
 
-      def perform
         indent = (' ' * 2)
         second_indent = indent * 2
-        lines = [%Q(require "#{Scaffold.helper_file}"), %Q(), %Q(describe #{const} do)]
-        if class?
-          initialization_args.each do |arg|
+
+        # header
+        lines = [
+          %Q(# spring rspec),
+          %Q(describe #{@parser.name} do)
+        ]
+
+        if @parser.class?
+          @parser.initialization_args.each do |arg|
             lines << %Q(#{indent}let(:#{arg.to_s.sub(/^[&*]/, '')}) {})
           end
           lines << %Q()
-          lines << %Q(#{indent}subject { described_class.new #{initialization_args.join(', ')} })
-        elsif module?
-          lines << %Q(#{indent}subject { Class.new { include #{const} }.new })
+          lines << %Q(#{indent}subject { described_class.new #{@parser.initialization_args.join(', ')} })
+        elsif @parser.module?
+          lines << %Q(#{indent}subject { Class.new { include #{@parser.name} }.new })
         end
+
         lines << %Q()
-        funcs.reject(&:private?).each do |func|
+
+        # handle Rails model scopes
+        if scope_definitions.any?
+          lines << %Q|#{indent}describe 'Scopes' do|
+
+          scope_definitions.each do |scope_name|
+            lines << %Q|#{second_indent}describe '.#{scope_name}' do|
+            lines << %Q|#{' ' * 6}xit "should collect TODO" do|
+            lines << %Q|#{' ' * 6}end|
+            lines << %Q|#{second_indent}end|
+            lines << %Q||
+          end
+
+          lines << %Q|#{indent}end|
+          lines << %Q()
+        end
+
+        # handle class and instance methods
+        @parser.funcs.reject(&:private?).each do |func|
           lines << %Q(#{indent}describe "#{func.class? ? '.' : '#'}#{func.name}" do)
           func.assignments.each do |assignment|
             lines << %Q(#{second_indent}it "#{assignment}" do) << %Q(#{second_indent}end)
@@ -41,9 +62,55 @@ module RSpec
           end
           lines << %Q(#{indent}end) << %Q()
         end
+
         lines << %Q(end) << %Q()
-        lines
+
+        return lines
       end
+
+      private
+
+        def scope_definitions
+          return @scope_definitions ||= scope_definitions_in_sexp(@parser.sexp)
+        end
+
+        def scope_definitions_in_sexp(sexp_or_symbol)
+          is_a_cope_definition = begin
+            sexp_or_symbol.respond_to?(:map) && sexp_or_symbol.to_a[2] == :scope
+          rescue
+            false
+          end
+
+          definitions = if is_a_cope_definition
+            begin
+              [sexp_or_symbol.to_a[3][1]] #=> scope symbol name
+            rescue
+              [nil]
+            end
+          elsif sexp_or_symbol.class == Sexp && sexp_or_symbol.size > 1
+            # try looping over and going deeper
+            sexp_or_symbol.map do |nested_sexp|
+              if nested_sexp.class == Sexp && nested_sexp.size > 1 && %i|class module iter|.include?(nested_sexp[0])
+                # there's nested_sexps, go deeper
+                nested_sexp.map do |deep_nested_sexp|
+                  scope_definitions_in_sexp(deep_nested_sexp)
+                end
+              else
+                begin
+                  [nested_sexp.to_a[3][1]] if nested_sexp.to_a[2] == :scope  #=> scope symbol name
+                rescue
+                  [nil]
+                end
+              end
+            end
+          else
+            # sexp_or_symbol happends to be a symbol, do nothing
+            [nil]
+          end
+
+          return definitions.flatten.compact
+        end
+
     end
   end
 end

data/lib/rspec/scaffold/runner.rb

@@ -4,18 +4,22 @@ module RSpec
       attr_reader :file
 
       # @param [Pathname] file
-      def initialize(file)
-        @file = Pathname.new(file)
+      def initialize(file = nil)
+        @file = Pathname.new(file) if file
       end
 
+      # V1, DEPRECATED
       def perform
         fail ArgumentError, %Q(File or directory does not exist: "#{file}") if !File.exists?(file) && !File.exists?("#{file}.rb")
+
         ruby_files.each do |ruby_file|
           rspec_file = Pathname.new(spec_file(ruby_file))
           spec_file_path = rspec_file.to_s[%r|/(spec/.+)|, 1]
-          next if rspec_file.exist?.tap { |exists| log "- #{spec_file_path} - already exists", :gray if exists }
-          spec = generate_spec(ruby_file)
+          next if rspec_file.exist?.tap { |exists| log "- #{spec_file_path} - already exists", :puts if exists }
+
+          spec = generate_spec(Pathname.new(File.expand_path(ruby_file)))
           next unless spec
+
           log "+ #{spec_file_path}"
           FileUtils.mkdir_p(rspec_file.parent)
           File.open(rspec_file, 'wb') do |f|
@@ -24,20 +28,25 @@ module RSpec
         end
       end
 
-      #
-      # Private
-      #
-
-      def generate_spec(ruby_file)
-        spec = RSpec::Scaffold::Generator.new Pathname.new(File.expand_path(ruby_file))
-        if spec.funcs.any?
-          spec.perform
+      # @param [String/Pathname] ruby
+      def generate_spec(ruby)
+        ryan = Ryan.new(ruby)
+        if ryan.funcs.any?
+          RSpec::Scaffold::Generator.new(ryan).perform
         else
-          log "- #{ruby_file} - no methods", :gray
+          log "- #{truncate(ruby)} - no methods", :puts
           nil
         end
       rescue => e
-        log "! #{ruby_file} - #{e.inspect.gsub /^#<|>$/, ''}", :red
+        log "! #{truncate(ruby)} - #{e.inspect.gsub /^#<|>$/, ''}\n#{e.backtrace.take(10)}", :red
+      end
+
+      #
+      # Private
+      #
+
+      def truncate(str)
+        str.to_s.scan(/.+/).take(2).tap { |x| x[1..-1].each { |i| i[0..-1] = '...' } }.join
       end
 
       def ruby_files
@@ -70,7 +79,7 @@ module RSpec
       end
 
       def log(msg = nil, color = :green)
-        HighLine.new.say %Q(  <%= color('#{msg}', :#{color}) %>)
+        return RSpec::Scaffold.log(msg, color)
       end
     end
   end

data/lib/rspec/scaffold/spec_location_builder.rb

@@ -0,0 +1,29 @@
+module RSpec
+  module Scaffold
+    class SpecLocationBuilder
+      # manages inferring spec file locations for code files.
+
+      # @param [Pathname] project_root
+      # @param [Pathname] file_path
+      def initialize(project_root, file_path)
+        @project_root = Pathname(project_root)
+        @file_path    = Pathname(file_path)
+        @relative_file_path = (@file_path.relative? ? Pathname(@file_path) : ( Pathname(@file_path.to_s.sub(@project_root.to_s, '')) ))
+      end
+
+      # RSpec::Scaffold::SpecLocationBuilder.new("/home/dev/projects/some_app", "/app/models/user.rb").spec_location
+      def spec_location
+        # for default rails app dir code
+        @spec_location ||= if @relative_file_path.to_s[%r'\A/?app/']
+          # replace first 'app/' with 'spec/' and change ending a bit
+          @project_root.join(@relative_file_path.sub(%r'\A/?app/', 'spec/'))
+        else
+          @project_root.join("spec").join(@relative_file_path.to_s.sub(%r'\A/', ''))
+        end.sub(%r'\.rb\z', '_spec.rb')
+
+        return @spec_location
+      end
+
+    end
+  end
+end

data/lib/rspec/scaffold/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module Scaffold
-    VERSION = "1.0.0".freeze
+    VERSION = "2.0.0".freeze
   end
 end

data/lib/rspec/scaffold.rb

@@ -1,23 +1,78 @@
 require "pathname"
 require "delegate"
-require "rspec"
+#require "rspec"
 require "ryan"
-require "highline"
+require "luks"
 
 module RSpec
   module Scaffold
-    autoload :Version, "rspec/scaffold/version"
-    autoload :Runner, "rspec/scaffold/runner"
-    autoload :Generator, "rspec/scaffold/generator"
+    autoload :Cli, "rspec/scaffold/cli"
     autoload :ConditionExhibit, "rspec/scaffold/condition_exhibit"
+    autoload :FileWriter, "rspec/scaffold/file_writer"
+    autoload :Generator, "rspec/scaffold/generator"
+    autoload :DirExpander, "rspec/scaffold/dir_expander"
+    autoload :Runner, "rspec/scaffold/runner"
+    autoload :SpecLocationBuilder, "rspec/scaffold/spec_location_builder"
+    autoload :Version, "rspec/scaffold/version"
 
+    # loads gem's rake tasks in main app
+    # Dir["#{RSpec::Scaffold.root}" + "lib/rspec/scaffold/tasks/**/*.rake"].each { |ext| load ext } if defined?(Rake)
+
+    # DEPRECATED
     def self.helper_file
-      if defined?(::Rails) && RSpec::Core::Version::STRING.to_s >= '3'
+      if Object.const_defined?("Rails") && RSpec::Core::Version::STRING.to_s >= '3'
         'rails_helper'
       else
         'spec_helper'
       end
     end
+
+    # RSpec::Scaffold.testify_file(filepath)
+    # mode = :to_file, :to_text
+    def self.testify_file(filepath, mode=:to_text, out: nil)
+      begin
+        test_scaffold = RSpec::Scaffold::Generator.new(Ryan.new(filepath)).perform
+      rescue => e
+        RSpec::Scaffold.log("- parse error in '#{filepath}': #{e.message}", :red)
+        return nil
+      end
+
+      scaffold_text = test_scaffold.join("\n")
+
+      if out # pre-empts :mode and infers :to_file
+        return RSpec::Scaffold::FileWriter.new(out, scaffold_text).write!
+      else
+        case mode
+        when :to_file
+          output_filename = filepath.sub(%r'\.rb\z', '_spec.rb')
+          return RSpec::Scaffold::FileWriter.new(output_filename, scaffold_text).write!
+        when :to_text
+          return scaffold_text
+        else
+          raise("Unrecognized mode")
+        end
+      end
+    end
+
+    # RSpec::Scaffold.testify_text(text)
+    def self.testify_text(text)
+      test_scaffold = RSpec::Scaffold::Generator.new(Ryan.new(text)).perform
+      return test_scaffold.join("\n")
+    rescue => e
+      message = "parse error: #{e.message}"
+      RSpec::Scaffold.log(message, :red)
+      return message
+    end
+
+    def self.root
+      Pathname.new File.expand_path('../../..', __FILE__)
+    end
+
+    # refactored from runner for more general use
+    def self.log(msg = nil, color = :green)
+      return send(color, "  #{msg}")
+    end
+
   end
 end
 

data/rspec-scaffold.gemspec

@@ -4,25 +4,30 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'rspec/scaffold/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "rspec-scaffold"
-  spec.version       = RSpec::Scaffold::VERSION
-  spec.authors       = ["Ryan Buckley"]
-  spec.email         = ["arebuckley@gmail.com"]
+  spec.name    = "rspec-scaffold"
+  spec.version = RSpec::Scaffold::VERSION
+  spec.authors = ["Ryan Buckley"]
+  spec.email   = ["arebuckley@gmail.com"]
 
-  spec.summary       = %q{Generates RSpec scaffolding for existing code}
-  spec.description   = %q{Generates RSpec scaffolding for conditions and ivar assignments}
-  spec.homepage      = "https://github.com/ridiculous/rspec-scaffold"
+  spec.summary     = %q{Generates RSpec scaffolding for existing code}
+  spec.description = %q{Generates test files based on your codes logic, setting up the initialization args and nested context blocks}
+  spec.homepage    = "https://github.com/ridiculous/rspec-scaffold"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.executables   = ["rspec-scaffold"] # NB, as of bundler 0.12, executables *must* be in /exe
   spec.require_paths = ["lib"]
   spec.license       = 'MIT'
 
+  spec.required_ruby_version = '>= 2.0.0'
+
   spec.add_dependency 'highline', '~> 1.6'
-  spec.add_dependency 'ryan', '~> 1.0'
+  spec.add_dependency 'luks' # , '~> 1.6'
+  spec.add_dependency 'ryan', '~> 1.2.1'
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", ">= 3.2", "< 4"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", ">= 3.2", "< 5"
+  spec.add_development_dependency "fakefs", "~> 0.11.0" # fakes filesystem, useful for testing file outputs.
+  spec.add_development_dependency "rake-release", "~> 1.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-scaffold
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Ryan Buckley
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2016-01-28 00:00:00.000000000 Z
+date: 2023-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -24,48 +24,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: luks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: ryan
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.2.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -75,7 +89,7 @@ dependencies:
         version: '3.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -85,28 +99,65 @@ dependencies:
         version: '3.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4'
-description: Generates RSpec scaffolding for conditions and ivar assignments
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+- !ruby/object:Gem::Dependency
+  name: rake-release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+description: Generates test files based on your codes logic, setting up the initialization
+  args and nested context blocks
 email:
 - arebuckley@gmail.com
-executables: []
+executables:
+- rspec-scaffold
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.md
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- exe/rspec-scaffold
 - lib/rspec/scaffold.rb
+- lib/rspec/scaffold/cli.rb
 - lib/rspec/scaffold/condition_exhibit.rb
+- lib/rspec/scaffold/dir_expander.rb
+- lib/rspec/scaffold/file_writer.rb
 - lib/rspec/scaffold/generator.rb
 - lib/rspec/scaffold/runner.rb
+- lib/rspec/scaffold/spec_location_builder.rb
 - lib/rspec/scaffold/tasks/scaffold.rake
 - lib/rspec/scaffold/version.rb
 - rspec-scaffold.gemspec
@@ -114,7 +165,7 @@ homepage: https://github.com/ridiculous/rspec-scaffold
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -122,16 +173,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Generates RSpec scaffolding for existing code
 test_files: []