rspec-scaffold 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 29a784e5cbccef665cac2b16d1cdab56c73d7bad
+  data.tar.gz: 3c92a9a94cd6ff6291d165907ea3a576fa8da2d7
+SHA512:
+  metadata.gz: 3a24149667ca095cb344608e5e2a3f9adf378c459fd2334bbc03227fc7d3477a1b3ee58e4ae67d5181e8fbc56c98059f763282aa5ffa35c00fbb2fd5439d0c71
+  data.tar.gz: 800906cb9b5e1b682c2c762be5cdb23b888456b91b874c9cb96cd15159237bb04ba992fab6100721de67ba55e69a3d506a6e48330e360367e46609a858374e34

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.ruby-gemset

@@ -0,0 +1 @@
+rspec-scaffold

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.2

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.10.4

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rspec-scaffold.gemspec
+gemspec
+
+group :development, :test do
+  gem 'byebug'
+end

data/README.md

@@ -0,0 +1,69 @@
+# RSpec::Scaffold
+
+Generates RSpec scaffolding for existing code. Takes either a file or a directory.
+
+## Installation
+
+```ruby
+gem 'rspec-scaffold'
+```
+
+## Usage
+
+```bash
+rake rspec:scaffold[lib]
+```
+
+## Example
+
+```ruby
+# app/models/ability.rb
+class Ability
+  include CanCan::Ability
+
+  def initialize(user)
+    if user.admin?
+      can :manage, :all
+    else
+      can :read, :all
+      can :update, User do |u|
+        u.id == user.id
+      end
+    end
+  end
+end
+```
+
+Outputs:
+
+```ruby
+# spec/models/ability_spec.rb
+require "spec_helper"
+
+describe Ability do
+  let(:user) {}
+
+  subject { described_class.new user }
+
+  describe "#initialize" do
+    context "when user.admin?" do
+      before {}
+    end
+
+    context "unless user.admin?" do
+      before {}
+    end
+  end
+end
+```
+
+## 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.
+
+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.
+

data/Rakefile

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift './lib'
+require 'rspec/core/rake_task'
+require 'bundler/setup'
+Bundler.setup
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/lib/**/*_spec.rb'
+end
+desc 'Run specs'
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rspec/scaffold"
+
+# 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

data/bin/setup

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

data/lib/rspec/scaffold/condition_exhibit.rb

@@ -0,0 +1,108 @@
+module RSpec
+  module Scaffold
+    class ConditionExhibit < DelegateClass(Ryan::Condition)
+
+      attr_reader :second_indent, :indent
+
+      def initialize(condition, indent = '    ')
+        super(condition)
+        @indent, @second_indent = indent, indent + (' ' * 2)
+      end
+
+      # @param [Array] contexts just used for recursive calls
+      # @return [Array]
+      def render(contexts = [])
+        contexts.concat(context(:statement, [:edit_prefix, :escape]) do |lines|
+          lines.concat it(:if_text, :escape)
+          lines << %Q() if nested_conditions.any?
+          nested_conditions.each { |nc| self.class.new(nc, second_indent).render(lines) }
+          lines
+        end)
+        contexts << %Q()
+        if parts.empty?
+          contexts.concat(context(:statement, [:negate, :edit_prefix, :escape]) do |lines|
+            lines.concat it(:else_text, :escape)
+          end)
+        end
+        parts.each do |condition_part|
+          contexts.concat conditional_parts(condition_part)
+        end
+        contexts
+      end
+
+      #
+      # Private
+      #
+
+      def context(*args)
+        list = [%Q(#{indent}context #{call_with_modifiers(*args)} do), %Q(#{second_indent}before {})]
+        yield list if block_given?
+        list << %Q(#{indent}end)
+        list
+      end
+
+      def it(*args)
+        return [] unless we_should_print? public_send(args.first)
+        [%Q(), %Q(#{second_indent}it #{call_with_modifiers(*args)} do), %Q(#{second_indent}end)]
+      end
+
+      def call_with_modifiers(method_name, modifiers = [])
+        Array(modifiers).inject(public_send(method_name)) { |txt, modifier| public_send(modifier, txt) }
+      end
+
+      def conditional_parts(condition_part, contexts = [])
+        condition_part = self.class.new(condition_part, indent)
+        contexts.concat(condition_part.context(:statement, [:edit_prefix, :escape]) do |lines|
+          lines.concat condition_part.it(:if_text, :escape)
+        end)
+        if condition_part.should_print? condition_part.else_text
+          contexts.concat(condition_part.context(:statement, [:negate, :edit_prefix, :escape]) do |lines|
+            lines.concat condition_part.it(:else_text, :escape)
+          end)
+        end
+        contexts
+      end
+
+      def escape(txt)
+        txt.gsub!(/#\{(.*?)\}/m, '\#{\1}') # escape interpolations
+        txt.gsub!(/"/m, '\"') # escape double quotes
+        txt.gsub!(/\\\\/m, '\\') # replace multiple escapes with a single escape
+        %Q("#{truncate(txt)}")
+      end
+
+      def truncate(txt, length = 120)
+        txt = txt.lstrip
+        length -= 3
+        if txt.length > length
+          txt[0, length] + '...'
+        else
+          txt
+        end
+      end
+
+      def negate(txt)
+        if txt[/^unless /]
+          txt.sub /^unless /, 'if '
+        else
+          "not #{txt}"
+        end
+      end
+
+      def edit_prefix(txt)
+        txt.sub! /^if /, 'when '
+        txt.sub! /^not if /, 'unless '
+        txt.sub! /^if not /, 'unless '
+        if txt !~ /^(when|unless|not)/
+          txt = "when #{txt}"
+        end
+        txt
+      end
+
+      def we_should_print?(txt)
+        !txt.empty? and txt !~ /\n/
+      end
+
+      alias should_print? we_should_print?
+    end
+  end
+end

data/lib/rspec/scaffold/generator.rb

@@ -0,0 +1,49 @@
+module RSpec
+  module Scaffold
+    class Generator < DelegateClass(Ryan)
+
+      # = Class
+      # generate a rspec file based on existing code
+
+      attr_reader :file
+
+      def initialize(file)
+        @file = file
+        super Ryan.new(file)
+      end
+
+      def const
+        @const ||= Kernel.const_get(name)
+      end
+
+      def perform
+        indent = (' ' * 2)
+        second_indent = indent * 2
+        lines = [%Q(require "spec_helper"), %Q(), %Q(describe #{const} do)]
+        if class?
+          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 })
+        end
+        lines << %Q()
+        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)
+          end
+          lines << %Q() if func.conditions.any? and func.assignments.any?
+          func.conditions.each do |condition|
+            lines.concat ConditionExhibit.new(condition, second_indent).render
+          end
+          lines << %Q(#{indent}end) << %Q()
+        end
+        lines << %Q(end) << %Q()
+        lines
+      end
+    end
+  end
+end

data/lib/rspec/scaffold/runner.rb

@@ -0,0 +1,77 @@
+module RSpec
+  module Scaffold
+    class Runner
+      attr_reader :file
+
+      # @param [Pathname] file
+      def initialize(file)
+        @file = Pathname.new(file)
+      end
+
+      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 unless spec
+          log "+ #{spec_file_path}"
+          FileUtils.mkdir_p(rspec_file.parent)
+          File.open(rspec_file, 'wb') do |f|
+            f << spec.join("\n")
+          end
+        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
+        else
+          log "- #{ruby_file} - no methods", :gray
+          nil
+        end
+      rescue => e
+        log "! #{ruby_file} - #{e.inspect.gsub /^#<|>$/, ''}", :red
+      end
+
+      def ruby_files
+        if File.directory?(file)
+          Dir[File.join(file, '**', '*.rb')]
+        else
+          if file.extname.empty?
+            ["#{file}.rb"]
+          else
+            [file]
+          end
+        end
+      end
+
+      # @note subbing out /app/ is Rails specific
+      def spec_file(ruby_file)
+        File.join(spec_path, "#{specify(ruby_file)}").sub '/app/', '/'
+      end
+
+      def specify(file_name)
+        file_name.sub('.rb', '_spec.rb')
+      end
+
+      def spec_path
+        if File.directory?(File.expand_path('spec'))
+          File.expand_path('spec')
+        else
+          fail "Couldn't find spec directory"
+        end
+      end
+
+      def log(msg = nil, color = :green)
+        HighLine.new.say %Q(  <%= color('#{msg}', :#{color}) %>)
+      end
+    end
+  end
+end

data/lib/rspec/scaffold/tasks/scaffold.rake

@@ -0,0 +1,11 @@
+require "rake"
+
+namespace :rspec do
+  task :scaffold, [:file_name] => :environment do |_, args|
+    RSpec::Scaffold::Runner.new(args.file_name).perform
+  end
+
+  task :environment do
+    # no-op hook task
+  end if !Rake::Task.task_defined?(:environment) and !defined?(Rails)
+end

data/lib/rspec/scaffold/version.rb

@@ -0,0 +1,5 @@
+module RSpec
+  module Scaffold
+    VERSION = "0.1.0".freeze
+  end
+end

data/lib/rspec/scaffold.rb

@@ -0,0 +1,15 @@
+require "pathname"
+require "delegate"
+require "ryan"
+require "highline"
+
+module RSpec
+  module Scaffold
+    autoload :Version, "rspec/scaffold/version"
+    autoload :Runner, "rspec/scaffold/runner"
+    autoload :Generator, "rspec/scaffold/generator"
+    autoload :ConditionExhibit, "rspec/scaffold/condition_exhibit"
+  end
+end
+
+load "rspec/scaffold/tasks/scaffold.rake"

data/rspec-scaffold.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$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.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.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.require_paths = ["lib"]
+
+  spec.add_dependency 'highline', '~> 1.7'
+  spec.add_dependency 'ryan', '~> 1.0.0'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", ">= 3.2", "< 4"
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: rspec-scaffold
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ryan Buckley
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: ryan
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+description: Generates RSpec scaffolding for conditions and ivar assignments
+email:
+- arebuckley@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rspec/scaffold.rb
+- lib/rspec/scaffold/condition_exhibit.rb
+- lib/rspec/scaffold/generator.rb
+- lib/rspec/scaffold/runner.rb
+- lib/rspec/scaffold/tasks/scaffold.rake
+- lib/rspec/scaffold/version.rb
+- rspec-scaffold.gemspec
+homepage: https://github.com/ridiculous/rspec-scaffold
+licenses: []
+metadata: {}
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Generates RSpec scaffolding for existing code
+test_files: []