spec_writer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 28afe1ceedda49fc65d0b2a73cf9bf7e58dc1694
+  data.tar.gz: 400281af3d659bbf225bbb9761686ded29733cd0
+SHA512:
+  metadata.gz: 93dc4a9324b7d25bba54cf22ca40f614139f2e2e95fce2831e50742e44c791c6aaaf4714be8b76ce084fc00a8940bb5df7711917f51392af7f814d4486f981a3
+  data.tar.gz: e66a7ef504d34247074a8d69d8ce9a2750adf248ee0b2944e3b1600c8902829d81a37d8b3866a6a5b6d731af04de5e1e358a5d604e46267647903a11be81a7bb

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in spec_writer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Sunday Adefila
+
+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,70 @@
+# SpecWriter
+
+We know you don't do TDD :stuck_out_tongue: but what about DDT? :smile: 
+
+We can help you DDT so you can TDD.
+
+SpecWriter is a tool aimed to help in promoting the art of TDD, by first helping to compile the most basic tests ( supporting only model tests for now ) for your new rails application, so you can continue on the testing path as you progress in the development process.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'spec_writer', group: development
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install spec_writer
+    
+## Dependencies
+The usage of this gem depends on the use of the following tools/frameworks:
+
+1. Rails
+2. [Rspec-rails](https://github.com/rspec/rspec-rails) ( the testing framework for rails > 3.0 )
+3. [Factory-Girls](https://github.com/thoughtbot/factory_girl_rails)
+
+Others that might be useful, but not entirely compulsory includes:
+
+ - Database cleaner
+ - Faker
+
+## Usage
+
+In a rails application, set up the rspec testing, with factories in the `spec/factories` directory...
+
+Next, to have SpecWriter compile model test for a model, simply run: 
+
+    $ rails generate model_spec MODEL
+generating for User model, for example, will be:
+
+    $ rails generate model_spec User
+This will generate a spec file in the `spec/models/<model>_spec.rb` and populate with some good basic tests.
+
+running `rspec` here might show some failing tests due to absence of required factory, either create those factories, or fix test as appropriate.
+
+#### Tests covered are:
+ - Validation tests
+ - Association tests
+ - Graceful destroyals for associated models ( This is usually useful to identify where the `dependent: destroy` option has been omited so as to avoid the common `update or delete on table "<table>" violates foreign key constraint` error on a resource.)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/SundayAdefila/spec_writer.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "spec_writer"
+
+# 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,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/lib/generators/model_spec/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate model_spec Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/model_spec/model_spec_generator.rb

@@ -0,0 +1,9 @@
+require 'rails/generators/base'
+
+class ModelSpecGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+
+	def copy_spec_file
+		template "model_spec.rb", "spec/models/#{file_name.singularize.downcase}_spec.rb"
+	end
+end

data/lib/generators/model_spec/templates/model_spec.rb

@@ -0,0 +1,108 @@
+<% klass = class_name.camelize.singularize.constantize %>
+
+<% validations = klass.validators.group_by{|a| a.kind} %>
+<% validators = validations.keys %>
+
+<% owner_klasses = klass.reflect_on_all_associations(:belongs_to).map{|asc| asc.name.to_s} %>
+<% supa_klasses = klass.reflections.collect{|a, b| {class_name: b.class_name, name: b.name.to_s, options: b.options} if b.macro==:has_many}.compact %>
+<% direct_supa_klasses = klass.reflections.collect{|a, b| {class_name: b.class_name, name: b.name.to_s, options: b.options} if b.macro==:has_one}.compact %>
+
+# TODO: maybe add one for :has_and_belongs_to_many?
+# TODO: Implement insertions for existing files... why??
+
+require 'rails_helper'
+
+RSpec.describe <%= klass %>, type: :model do
+  it "should have a valid factory" do
+    <%= file_name %> = FactoryGirl.build(:<%= file_name %>)
+    expect(<%= file_name %>).to be_valid
+  end
+
+  describe "Validators" do
+
+  	<% if validators.include? :presence %>
+  		<% validations[:presence][0].attributes.each do |attr| %>
+  			it "should ensure the presence of <%= attr %>" do
+  				<%= file_name %> = FactoryGirl.build(:<%= file_name %>, <%= attr %>: nil)
+  				expect(<%= file_name %>).not_to be_valid
+  				expect(<%= file_name %>.errors[:<%= attr %>]).to be_present
+  			end
+  		<% end %>
+  	<% end %>
+
+  	<% if validators.include? :uniqueness %>
+  		<% validations[:uniqueness].each do |v| %>
+  			<% scope = v.options[:scope] %>
+	  		<% v.attributes.each do |attr| %>
+		  		it "should ensure the uniqueness of <%= attr %>" do
+		      	<%= file_name %> = FactoryGirl.create(:<%= file_name %>)
+						<% if scope %>
+							new_<%= file_name %> = FactoryGirl.build(:<%= file_name %>, <%= attr %>: <%= file_name %>.<%= attr %>, <%= scope %>: <%= file_name %>.<%= scope %>)
+						<% else %>
+		      		new_<%= file_name %> = FactoryGirl.build(:<%= file_name %>, <%= attr %>: <%= file_name %>.<%= attr %>)
+		      	<% end %>
+		      	expect(new_<%= file_name %>).not_to be_valid
+		      	expect(new_<%= file_name %>.errors[:<%= attr %>]).to be_present
+		    	end
+		    <% end %>
+		  <% end %>
+  	<% end %>
+  end
+
+  <% unless owner_klasses.empty? and supa_klasses.empty? %>
+
+	  describe "Associations" do
+	  	<% owner_klasses.each do |owner| %>
+	  		it "should belong to a <%= owner %>" do
+	  			<%= owner %> = FactoryGirl.create(:<%= owner %>)
+	  			<%= file_name %> = FactoryGirl.build(:<%= file_name %>, <%= owner %>: <%= owner %>)
+	  			expect(<%= file_name %>.<%= owner %>).to eq <%= owner %>
+	  		end
+	  	<% end %>
+
+	  	<% supa_klasses.each do |child| %>
+	  		it "should allow multiple <%= child[:name] %>" do
+	  			<%= file_name %> = FactoryGirl.create(:<%= file_name %>)
+
+	  			3.times.each do |n|
+	  				<%= child[:name].singularize %> = FactoryGirl.create(:<%= child[:class_name].underscore %>)
+	  				<%= file_name %>.<%= child[:name] %> << <%= child[:name].singularize %>
+	  				<%= "#{file_name}_#{child[:name]}" %> = <%= file_name %>.<%= child[:name] %>
+	  				expect(<%= "#{file_name}_#{child[:name]}" %>.count).to eq n.next
+	  				expect(<%= "#{file_name}_#{child[:name]}" %>).to include <%= child[:name].singularize %>
+	  			end
+	  		end
+
+	  	<% end %>
+	  end
+	<% end %>
+
+	<% unless direct_supa_klasses.empty? and supa_klasses.empty? %>
+		describe "Graceful Destroyal" do
+			<% direct_supa_klasses.each do |d_s_k| %>
+				<% next if d_s_k[:options].include? :through %>
+				it "should destroy the associated <%= d_s_k[:name] %> when deleted" do
+					<%= file_name %> = FactoryGirl.create(:<%= file_name %>)
+					<%= d_s_k[:name] %> = FactoryGirl.create(:<%= d_s_k[:name] %>)
+					<%= file_name %>.<%= d_s_k[:name].pluralize %> << <%= d_s_k[:name] %>
+
+					expect{ <%= file_name %>.destroy }.to change(<%= d_s_k[:class_name].constantize %>, :count).by -1
+				end
+			<% end %>
+
+			<% supa_klasses.each do |child| %>
+				<% next if child[:options].include? :through %>
+				it "should destroy the associated <%= child[:name] %> when deleted" do
+					<%= file_name %> = FactoryGirl.create(:<%= file_name %>)
+					<%= file_name %>.<%= child[:name] %>.create(FactoryGirl.attributes_for(:<%= child[:class_name].underscore %>))
+
+					expect{ <%= file_name %>.destroy }.to change(<%= child[:class_name].constantize %>, :count).by -1
+				end
+			<% end %>
+		end
+	<% end %>	
+
+  describe "Behavior" do
+  	pending "add some examples to #{__FILE__} for behaviours or delete the 'Behaviour' test there."
+  end
+end

data/lib/spec_writer.rb

@@ -0,0 +1,5 @@
+require "spec_writer/version"
+
+module SpecWriter
+  # Your code goes here...
+end

data/lib/spec_writer/version.rb

@@ -0,0 +1,3 @@
+module SpecWriter
+  VERSION = "0.1.0"
+end

data/spec_writer.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'spec_writer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "spec_writer"
+  spec.version       = SpecWriter::VERSION
+  spec.authors       = ["Sunday Adefila"]
+  spec.email         = ["adefilaedward@gmail.com"]
+
+  spec.summary       = %q{Automate Rspec test writing for common MVC specs}
+	spec.description   = %q{Rspec model tests only comes with one line: 'pending "add some examples to (or delete) #{__FILE__}"'. This gem seeks to populate the model spec with basic tests like validations, relationships, etc..., and then some.}
+  spec.homepage      = "https://github.com/SundayAdefila/spec_writer"
+  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"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  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_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: spec_writer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sunday Adefila
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 'Rspec model tests only comes with one line: ''pending "add some examples
+  to (or delete) #{__FILE__}"''. This gem seeks to populate the model spec with basic
+  tests like validations, relationships, etc..., and then some.'
+email:
+- adefilaedward@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/model_spec/USAGE
+- lib/generators/model_spec/model_spec_generator.rb
+- lib/generators/model_spec/templates/model_spec.rb
+- lib/spec_writer.rb
+- lib/spec_writer/version.rb
+- spec_writer.gemspec
+homepage: https://github.com/SundayAdefila/spec_writer
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Automate Rspec test writing for common MVC specs
+test_files: []