easy_rspec 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: '08d727b9720fc991592860598576221093c87245'
+  data.tar.gz: ce17347bd3f9aed71d9ae92064ad64e04a37251d
+SHA512:
+  metadata.gz: c2ecaa25a837ddcb5fccea6cd5fb965558e40b20786d5af7f529f9df83b57476688ba5279576f7020c01f558259f93d79762af9c434bc8d6d3b3dc82c164a973
+  data.tar.gz: 7e377718aee55b5f5f35a7cc07a5c2d00a6010754e44816d743b50b55bfefe4bbac51970dea29093be891a3bd8bb83b69074f3ade1777f363f42b8f059e74c44

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,14 @@
+before_install: gem install bundler -v 1.17.3
+language: ruby
+rvm:
+  - 2.3.7
+cache: bundler
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --debug --exit-code $TRAVIS_TEST_RESULT
+

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in easy_rspec.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    easy_rspec (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    fakefs (0.20.0)
+    json (2.2.0)
+    method_source (0.9.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rb-readline (0.5.5)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  easy_rspec!
+  fakefs
+  pry
+  rake (~> 10.0)
+  rb-readline
+  rspec (~> 3.0)
+  simplecov
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Jason Mattingly
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,76 @@
+# EasyRspec
+[![Maintainability](https://api.codeclimate.com/v1/badges/25a2889cda5d88e4d9df/maintainability)](https://codeclimate.com/github/jasonmattingly/easy_rspec/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/25a2889cda5d88e4d9df/test_coverage)](https://codeclimate.com/github/jasonmattingly/easy_rspec/test_coverage)
+[![build status](https://travis-ci.org/jasonmattingly/easy_rspec.svg?branch=master)](https://travis-ci.org/jasonmattingly/easy_rspec)
+
+EasyRspec allows you to build an RSpec test file from scratch with a single command. The RSpec test file will be generated with:
+1. A file path mirroring the path of the file being tested.
+
+    **Original file path:** `app/models/users/customer.rb`
+
+    **Generated test file path:** `spec/models/users/customer_spec.rb`
+2. Correct headers describing the class being tested
+
+    **Original file header:** `class Customer < ApplicationRecord`
+
+    **Generated test file header:** `describe Customer do`
+3. Describe blocks for instance and class methods found in the original file
+
+    **Original file:**
+
+    ```ruby
+    class Customer < ApplicationRecord
+      def name
+        if first_name && last_name
+          "#{first_name} #{last_name}"
+        else
+          "Lu Peachem"
+        end
+      end
+
+      def self.always_right?
+        false
+      end
+    end
+    ```
+    **Generated test file:**
+    ```ruby
+    describe Customer do
+      describe '#name' do
+        context '' do
+          it '' do
+          end
+        end
+      end
+
+      describe '.always_right?' do
+        context '' do
+          it '' do
+          end
+        end
+      end
+    end
+    ```
+## Install
+```ruby
+gem install easy_rspec
+```
+Or add to your Gemfile:
+```ruby
+gem 'easy_rspec'
+```
+## Usage
+Simply type `easy_rspec ClassName` into the console, where `ClassName` is the name of the class you'd like to create an RSpec test file for. If, for instance, the name of the class you'd like to create a test file for is `Customer`, you would type
+```
+easy_rspec Customer
+```
+and then press enter.
+
+If a test file already exists at the expected RSpec file path, you will receive an error message and no file will be created nor will the pre-existing file be changed.
+
+EasyRspec only generates tests for files that are located in your `app/` directory. If there are multiple files in your `app/` directory that match the class you requested, you will be asked to specify which file you were intending to create a test file for:
+```
+Which number represents your file path?
+0. app/models/users/customer.rb
+1. app/models/customer.rb
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "easy_rspec"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/easy_rspec.gemspec

@@ -0,0 +1,45 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "easy_rspec/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "easy_rspec"
+  spec.version       = EasyRspec::VERSION
+  spec.authors       = ["Jason Mattingly"]
+  spec.email         = ["jason.mattingly@hotmail.com"]
+
+  spec.summary       = %q{Create customized RSpec templates with a single command}
+  spec.description   = %q{Create customized RSpec templates with a single command}
+  spec.homepage      = "https://github.com/jasonmattingly/easy_rspec"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/jasonmattingly/easy_rspec"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rb-readline"
+  spec.add_development_dependency "fakefs"
+  spec.add_development_dependency "simplecov"
+end

data/lib/easy_rspec.rb

@@ -0,0 +1,11 @@
+require "easy_rspec/version"
+require 'pry'
+module EasyRspec
+  class Error < StandardError; end
+  require 'easy_rspec/original_file.rb'
+  require 'easy_rspec/rspec_file.rb'
+  require 'easy_rspec/rspec_file_builder.rb'
+  require 'easy_rspec/file_path_finder.rb'
+  require 'easy_rspec/file_contents.rb'
+  require 'easy_rspec/commandline_listener.rb'
+end

data/lib/easy_rspec/commandline_listener.rb

@@ -0,0 +1,5 @@
+module Kernel
+  def easy_rspec(klass_name)
+    EasyRspec::RspecFileBuilder.new(klass_name).build
+  end
+end

data/lib/easy_rspec/file_contents.rb

@@ -0,0 +1,42 @@
+module EasyRspec
+  class FileContents
+
+    attr_accessor :instance_methods, :class_methods
+
+    def initialize(file_path)
+      self.instance_methods = []
+      self.class_methods = []
+      find_contents(file_path)
+    end
+
+    private
+
+    def find_contents(file_path)
+      File.foreach(file_path) do |line|
+        if line_contains_class_method?(line)
+          class_methods << class_method_name(line)
+        end
+        if line_contains_instance_method?(line)
+          instance_methods << instance_method_name(line)
+        end
+      end
+    end
+
+    def line_contains_class_method?(line)
+      line.include?('def self.')
+    end
+
+    def class_method_name(line)
+      line.gsub('def self.','').gsub('\n', '').strip
+    end
+
+    def line_contains_instance_method?(line)
+      !line_contains_class_method?(line) && line.include?('def ')
+    end
+
+    def instance_method_name(line)
+      line.gsub('def ','').gsub('\n', '').strip
+    end
+
+  end
+end

data/lib/easy_rspec/file_path_finder.rb

@@ -0,0 +1,64 @@
+require 'find'
+module EasyRspec
+  class FilePathFinder
+
+    def initialize(klass_name)
+      @klass_name = klass_name
+    end
+
+    def file_path
+      file_path = if matching_file_paths.one?
+        matching_file_paths.first
+      elsif matching_file_paths.size > 1
+        user_selected_file
+      else
+        nil
+      end
+      raise "File path not found" unless file_path
+      file_path
+    end
+
+    private
+
+    def user_selected_file
+      max_index = matching_file_paths.size - 1
+      index = user_selected_index
+      if index && index <= max_index
+        matching_file_paths[index]
+      else
+        nil
+      end
+    end
+
+    def user_selected_index
+      puts "\nWhich number represents your file path?\n\n"
+      matching_file_paths.each_with_index do |file_path, index|
+        puts "#{index}. #{file_path}"
+      end
+      puts "\n"
+      user_provided_index = STDIN.gets.gsub(/[^\d]/, '')
+      user_provided_index ? user_provided_index.to_i : nil
+    end
+
+    def file_name
+      "#{file_name_components.join('/')}.rb"
+    end
+
+    def file_name_components
+      klass_name_components.map{ |component| component.gsub(/(.)([A-Z])/,'\1_\2').downcase }
+    end
+
+    def klass_name_components
+      @klass_name.to_s.split('::')
+    end
+
+    def matching_file_paths
+      @matching_file_paths ||= app_file_paths.select{ |file_path| file_path.include? "/#{file_name}" }
+    end
+
+    def app_file_paths
+      Find.find('app/').select { |file| File.extname(file) == '.rb' }
+    end
+
+  end
+end

data/lib/easy_rspec/original_file.rb

@@ -0,0 +1,23 @@
+module EasyRspec
+  class OriginalFile
+
+    attr_reader :klass_name
+
+    def initialize(klass_name)
+      @klass_name = Object.const_get(klass_name.to_s)
+    end
+
+    def path
+      @path ||= FilePathFinder.new(@klass_name).file_path
+    end
+
+    def directory
+      @directory ||= path.split(name).first
+    end
+
+    def name
+      @name ||= path.split('/').last
+    end
+
+  end
+end

data/lib/easy_rspec/rspec_file.rb

@@ -0,0 +1,21 @@
+module EasyRspec
+  class RspecFile
+
+    def initialize(original_file)
+      @original_file = original_file
+    end
+
+    def path
+      "#{directory}#{name}"
+    end
+
+    def directory
+      @original_file.directory.sub('app/', 'spec/')
+    end
+
+    def name
+      @original_file.name.sub('.rb', '_spec.rb')
+    end
+
+  end
+end

data/lib/easy_rspec/rspec_file_builder.rb

@@ -0,0 +1,57 @@
+require 'fileutils'
+module EasyRspec
+  class RspecFileBuilder
+
+    def initialize(klass_name)
+      @klass_name = klass_name
+    end
+
+    def build
+      raise "RSpec file already exists at #{rspec_file.path}" if File.file?(rspec_file.path)
+
+      FileUtils.mkdir_p rspec_file.directory
+      File.new(rspec_file.path, 'w')
+
+      File.open(rspec_file.path, "w+") do |f|
+        f.write("describe #{original_file.klass_name} do")
+
+        file_contents.instance_methods.each do |instance_method|
+          write_method_spec(f, "##{instance_method}")
+        end
+
+        file_contents.class_methods.each do |class_method|
+          write_method_spec(f, ".#{class_method}")
+        end
+
+        f.write("\n\nend\n")
+      end
+
+      "RSpec file created successfully at #{rspec_file.path}"
+    end
+
+    private
+
+    def original_file
+      @original_file ||= OriginalFile.new(@klass_name)
+    end
+
+    def rspec_file
+      @rspec_file ||= RspecFile.new(original_file)
+    end
+
+    def file_contents
+      @file_contents ||= FileContents.new(original_file.path)
+    end
+
+    def write_method_spec(file, descriptor)
+      file.write("\n")
+      file.write("\n  describe '#{descriptor}' do")
+      file.write("\n    context '' do")
+      file.write("\n      it '' do")
+      file.write("\n      end")
+      file.write("\n    end")
+      file.write("\n  end")
+    end
+
+  end
+end

data/lib/easy_rspec/version.rb

@@ -0,0 +1,3 @@
+module EasyRspec
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: easy_rspec
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jason Mattingly
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: rb-readline
+  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'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: Create customized RSpec templates with a single command
+email:
+- jason.mattingly@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- easy_rspec.gemspec
+- lib/easy_rspec.rb
+- lib/easy_rspec/commandline_listener.rb
+- lib/easy_rspec/file_contents.rb
+- lib/easy_rspec/file_path_finder.rb
+- lib/easy_rspec/original_file.rb
+- lib/easy_rspec/rspec_file.rb
+- lib/easy_rspec/rspec_file_builder.rb
+- lib/easy_rspec/version.rb
+homepage: https://github.com/jasonmattingly/easy_rspec
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/jasonmattingly/easy_rspec
+  source_code_uri: https://github.com/jasonmattingly/easy_rspec
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Create customized RSpec templates with a single command
+test_files: []