auto_specs 0.0.1.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a4483793151af907e9122b6886669d376466d9ed
+  data.tar.gz: a3090e708e8c061d6ebb154082242e494495e661
+SHA512:
+  metadata.gz: c4d0e9564b26463792efb941e56ca9b2383b856bc06d98c7df294f73cedea6fe8dcd266ced9af7af43c10b699da2160917223d5e913b9f645146708975d47fee
+  data.tar.gz: a9f3713fa900bfdb12ee194ea63f4b988c3819d3cec400477a40e03e7efe0270241170d7928a9a5339cb465639becc03de55e935a4ef7f9c37be492d263d07d3

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Aditya Kapoor
+
+MIT License
+
+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,52 @@
+# AutoSpecs
+
+*Don't Write specs yourself.*
+
+You might be caught up in the situation where all the development work is done first and then you have to write specs.
+
+The purpose of this gem is to serve as the bootstrap tool where all the known specs are already written for you.
+
+## Prerequisites
+
+In order to use this gem, the following steps needs to be done before installing this gem.
+
+1. install `rspec-rails` gem. Refer to the official page of the gem to know more.
+2. install `shoulda-matchers` gem. Refer to the official page of the gem to know more.
+
+The reason we chose `rspec` and `shoulda-matcher` is due to their simple and efficient DSL which makes writing tests easier.
+
+### Currently we are generating the `associations` but it is being planned for `validations` too. There is an [open issue](https://github.com/aditya-kapoor/auto-specs/issues/5) for this.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'auto_specs'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install auto_specs
+
+## Usage
+
+Upon installation in the rails app, the gem presents you with two `rake` tasks namely:
+
+1. auto_specs:model
+2. auto_spec:controller [TODO]
+
+Running `rake auto_specs:model` would generate the model file specs in the `spec` directory.
+
+## Contributing
+
+1. Fork it ( https://github.com/aditya-kapoor/auto_specs/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+require 'auto_specs/tasks'

data/auto_specs.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'auto_specs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "auto_specs"
+  spec.version       = AutoSpecs::VERSION
+  spec.authors       = ["Aditya Kapoor"]
+  spec.email         = ["aditya.kapoor@vinsol.com"]
+  spec.summary       = "Adds certain tasks that would automatically generate some specs for you."
+  spec.description   = ""
+  spec.homepage      = "https://github.com/aditya-kapoor/auto-specs"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/auto_specs/active_record/associations/mapping.rb

@@ -0,0 +1,13 @@
+module AutoSpecs
+  module ActiveRecord
+    module Associations
+      MAPPINGS = {
+        belongs_to:              'belong_to',
+        has_many:                'have_many',
+        has_one:                 'have_one',
+        has_many:                'have_many',
+        has_and_belongs_to_many: 'have_and_belongs_to_many'
+      }
+    end
+  end
+end

data/lib/auto_specs/active_record/associations/spec_builder.rb

@@ -0,0 +1,36 @@
+require 'auto_specs/active_record/associations/mapping'
+
+module AutoSpecs
+  module ActiveRecord
+    module Associations
+      class SpecBuilder
+        attr_accessor :macro, :name, :options
+
+        def initialize(ar_reflection_object)
+          @macro   = ar_reflection_object.macro
+          @name    = ar_reflection_object.name
+          @options = ar_reflection_object.options
+        end
+
+        def to_s
+          "it { should #{ shoulda_association_mapping }(:#{ name })#{ through_association }#{ dependent_option } }"
+        end
+
+        private
+
+          def shoulda_association_mapping
+            ActiveRecord::Associations::MAPPINGS[macro.to_sym]
+          end
+
+          # TODO..Improve this..
+          def through_association
+            options[:through] ? ".through(:#{ options[:through] })" : ""
+          end
+
+          def dependent_option
+            options[:dependent] ? ".dependent(:#{ options[:dependent] })" : ""
+          end
+      end
+    end
+  end
+end

data/lib/auto_specs/active_record/models/generator.rb

@@ -0,0 +1,23 @@
+require 'auto_specs/generators/model'
+
+module AutoSpecs
+  module ActiveRecord
+    class Models
+      def self.generate_files
+        # TODO: Use ActiveRecord::Base.descendants.
+        (::ActiveRecord::Base.connection.tables - %w(schema_migrations delayed_jobs)).each do |table|
+          model = table.classify.constantize rescue nil
+          model ? generate_file_for(model) : puts("Model not found : #{table}")
+        end
+      end
+
+      def self.generate_file_for(model)
+        puts "Generating Spec File for #{ model }"
+        Generators::Model.new(model).push_file
+      end
+      private_class_method :generate_file_for
+    end
+  end
+end
+
+AutoSpecs::ActiveRecord::Models.generate_files

data/lib/auto_specs/generators/base.rb

@@ -0,0 +1,27 @@
+module AutoSpecs
+  module Generators
+    class Base
+      SPEC_DIRECTORY_PATH = Rails.root.join('spec')
+
+      def self.ensure_specs_directory_exists!
+        ensure_path!(SPEC_DIRECTORY_PATH)
+      end
+
+      def self.ensure_path!(path)
+        FileUtils.mkdir_p(path) unless File.directory?(path)
+      end
+
+      private_class_method :ensure_specs_directory_exists!,
+                           :ensure_path!
+
+      ensure_specs_directory_exists!
+
+      private
+        def write_file
+          File.open(file_path, 'w') do |f|
+            f.write(file_contents)
+          end
+        end
+    end
+  end
+end

data/lib/auto_specs/generators/model.rb

@@ -0,0 +1,70 @@
+require 'auto_specs/generators/base'
+require 'auto_specs/active_record/associations/spec_builder'
+
+module AutoSpecs
+  module Generators
+    class Model < Base
+      MODEL_SPEC_DIRECTORY_PATH = SPEC_DIRECTORY_PATH.join('models')
+
+      def self.ensure_model_specs_directory_exists!
+        ensure_path!(MODEL_SPEC_DIRECTORY_PATH)
+      end
+
+      ensure_model_specs_directory_exists!
+
+      attr_accessor :model_name, :file_contents
+
+      def initialize(model_name)
+        @model_name    = model_name
+        @file_contents = ''
+      end
+
+      def push_file
+        within_file_code do
+          generate_code_for_associations
+          # generate_code_for_validations
+        end
+        write_file
+      end
+
+      private_class_method :ensure_model_specs_directory_exists!
+
+      private
+
+        def within_file_code
+          self.file_contents += %Q(require 'spec_helper'
+
+describe #{ model_name } do)
+          yield
+          self.file_contents += %Q(end)
+        end
+
+        def generate_code_for_associations
+          generate_code_block_for('Associations')
+          model_name.reflect_on_all_associations.each do |reflection|
+            self.file_contents += %Q(
+    #{ AutoSpecs::ActiveRecord::Associations::SpecBuilder.new(reflection).to_s })
+          end
+          self.file_contents += %Q(
+  end
+)
+        end
+
+        def generate_code_for_validations
+          generate_code_block_for('Validations')
+          model_name.validators.each do |validator|
+            # TODO...
+          end
+        end
+
+        def generate_code_block_for(entity)
+          self.file_contents += %Q(
+  context '#{ entity }' do)
+        end
+
+        def file_path
+          MODEL_SPEC_DIRECTORY_PATH.join("#{ model_name.to_s.underscore }_spec.rb")
+        end
+    end
+  end
+end

data/lib/auto_specs/tasks/generate.rake

@@ -0,0 +1,13 @@
+namespace :auto_specs do
+
+  desc 'Generate Specs for Models.'
+  task models: :environment do
+    AutoSpecs::Base.generate_spec_files_for('models')
+  end
+
+  desc 'Generates Specs for Controllers'
+  task :controllers do
+    # TODO...
+    # AutoSpecs::Base.generate_spec_files_for(:controllers)
+  end
+end

data/lib/auto_specs/tasks.rb

@@ -0,0 +1,5 @@
+require 'rake'
+
+%w(generate).each do |task|
+  load "auto_specs/tasks/#{ task }.rake"
+end

data/lib/auto_specs/version.rb

@@ -0,0 +1,3 @@
+module AutoSpecs
+  VERSION = "0.0.1.alpha"
+end

data/lib/auto_specs.rb

@@ -0,0 +1,14 @@
+require 'auto_specs/version'
+require 'auto_specs/tasks'
+
+module AutoSpecs
+  class Base
+    def self.generate_spec_files_for(entity)
+      if defined?(::ActiveRecord::Base)
+        require "auto_specs/active_record/#{ entity }/generator"
+      else
+        # TODO...
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: auto_specs
+version: !ruby/object:Gem::Version
+  version: 0.0.1.alpha
+platform: ruby
+authors:
+- Aditya Kapoor
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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'
+description: ''
+email:
+- aditya.kapoor@vinsol.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- auto_specs.gemspec
+- lib/auto_specs.rb
+- lib/auto_specs/active_record/associations/mapping.rb
+- lib/auto_specs/active_record/associations/spec_builder.rb
+- lib/auto_specs/active_record/models/generator.rb
+- lib/auto_specs/generators/base.rb
+- lib/auto_specs/generators/model.rb
+- lib/auto_specs/tasks.rb
+- lib/auto_specs/tasks/generate.rake
+- lib/auto_specs/version.rb
+homepage: https://github.com/aditya-kapoor/auto-specs
+licenses:
+- MIT
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Adds certain tasks that would automatically generate some specs for you.
+test_files: []
+has_rdoc: