code_driven_development 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 94d84107c92129b3d475303b3d6153d5b459462f
+  data.tar.gz: 626c026e88e042aa506242509963069cbe0c3f5c
+SHA512:
+  metadata.gz: 16a3e47fd78cbba40485de2795e6610a206b33636cd4a8b0b08f498526070b205851bfabec6e293c13fe137aea8cb3446be8a573e7f42e6601bc2b7dd1f914a9
+  data.tar.gz: 6cb4a8d957fb9bb496f0de6c822aec06b8433ffae10340fdfd16ed679ec833cf8038f09995a38256a91540f75f05197ad5cc45a9e6e3521a040ad6e65ff4d5f6

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format d

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Dan Finnie
+
+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,79 @@
+# CodeDrivenDevelopment
+
+Ever see a test and think, "wow, this test cares a lot about the exact abstract
+syntax tree of the code?"  CDD aims to generate tests like that.  Here's some example input:
+
+``` ruby
+class Bunker < ActiveRecord::Base
+  validate :password, secure: true
+  validate :location, :protected => true
+
+  def alert_staff
+    Staff.alert_all
+  end
+
+  def alert_president
+    SecretService.stand_down
+    President.alert
+  end
+end
+```
+
+And this is what CDD thinks of it:
+
+``` ruby
+describe Bunker do
+  it { should validate_secure_of :password }
+  it { should validate_protected_of :location }
+  
+  describe "#alert_staff" do
+    before do
+      allow(Staff).to receive :alert_all
+      described_class.new.alert_staff
+    end
+    it "calls Staff.alert_all" do
+      expect(Staff).to have_received :alert_all
+    end
+  end
+  
+  describe "#alert_president" do
+    before do
+      allow(SecretService).to receive :stand_down
+      allow(President).to receive :alert
+      described_class.new.alert_president
+    end
+    it "calls SecretService.stand_down" do
+      expect(SecretService).to have_received :stand_down
+    end
+    it "calls President.alert" do
+      expect(President).to have_received :alert
+    end
+  end
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'code_driven_development'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install code_driven_development
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/cdd

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'code_driven_development'
+puts CodeDrivenDevelopment::CodeDrivenDevelopment.new(ARGF.read).test_code.strip

data/code-driven-development.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'code_driven_development/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "code_driven_development"
+  spec.version       = CodeDrivenDevelopment::VERSION
+  spec.authors       = ["Dan Finnie"]
+  spec.email         = ["dan@danfinnie.com"]
+  spec.description   = %q{TOddddd: Write a gem description}
+  spec.summary       = %q{TOddddd: Write a gem summary}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency "ruby_parser"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/code_driven_development/code_driven_development.rb

@@ -0,0 +1,31 @@
+module CodeDrivenDevelopment
+  class CodeDrivenDevelopment
+    def initialize(implementation)
+      @implementation = implementation
+    end
+
+    def test_code
+      test_context = TestComponent::BlankSlate.new
+      ruleset.test_for(parse_tree, test_context)
+      test_context.indented_output
+    end
+
+    private
+
+    attr_reader :implementation
+
+    def parse_tree
+      RubyParser.new.parse(implementation)
+    end
+
+    def ruleset
+      Rule::Set.new(
+        Rule::Class,
+        Rule::Validation,
+        Rule::InstanceMethod,
+        Rule::MethodCall,
+        default: Rule::Default
+      )
+    end
+  end
+end

data/lib/code_driven_development/indented_output.rb

@@ -0,0 +1,24 @@
+module CodeDrivenDevelopment
+  class IndentedOutput
+    def initialize
+      @nesting = 0
+      @output = ""
+    end
+
+    def <<(str)
+      @output << current_indentation << str << "\n"
+    end
+
+    def indented
+      @nesting += 1
+      yield
+      @nesting -= 1
+    end
+
+    private
+
+    def current_indentation
+      "\t" * @nesting
+    end
+  end
+end

data/lib/code_driven_development/rule/abstract_rule.rb

@@ -0,0 +1,29 @@
+module CodeDrivenDevelopment
+  module Rule
+    class AbstractRule
+      def initialize(code, ruleset, test_context)
+        @code = code
+        @ruleset = ruleset
+        @test_context = test_context
+      end
+
+      def capable?
+        raise NotImplementedError.new("#{self.class} doesn't yet implement capable?!")
+      end
+
+      def test
+        raise NotImplementedError.new("#{self.class} doesn't yet implement test!")
+      end
+
+      private
+
+      attr_reader :code, :ruleset, :test_context
+
+      def recurse body, child_test_context
+        body.each do |line|
+          ruleset.test_for(line, child_test_context)
+        end
+      end
+    end
+  end
+end

data/lib/code_driven_development/rule/class.rb

@@ -0,0 +1,25 @@
+module CodeDrivenDevelopment
+  module Rule
+    class Class < AbstractRule
+      def capable?
+        code.sexp_type == :class
+      end
+
+      def test
+        new_context = TestComponent::Context.new(class_name)
+        recurse(class_body, new_context)
+        test_context << new_context
+      end
+
+      private
+
+      def class_body
+        code[3..-1]
+      end
+
+      def class_name
+        code[1]
+      end
+    end
+  end
+end

data/lib/code_driven_development/rule/default.rb

@@ -0,0 +1,8 @@
+module CodeDrivenDevelopment
+  module Rule
+    class Default < AbstractRule
+      def test
+      end
+    end
+  end
+end

data/lib/code_driven_development/rule/instance_method.rb

@@ -0,0 +1,28 @@
+module CodeDrivenDevelopment
+  module Rule
+    class InstanceMethod < AbstractRule
+      def capable?
+        code.sexp_type == :defn
+      end
+
+      def test
+        new_context = TestComponent::Context.new(%Q("##{method_name}"))
+        recurse(method_body, new_context)
+        test_context << new_context
+
+        # Do this last so that the method invocation is the last line in the before.
+        new_context.befores << "described_class.new.#{method_name}"
+      end
+
+      private
+
+      def method_name
+        code[1]
+      end
+
+      def method_body
+        code[3..-1]
+      end
+    end
+  end
+end

data/lib/code_driven_development/rule/method_call.rb

@@ -0,0 +1,26 @@
+module CodeDrivenDevelopment
+  module Rule
+    class MethodCall < AbstractRule
+      def capable?
+        code.sexp_type == :call &&
+          method_name != :validate
+      end
+
+      def test
+        test_context.befores << "allow(#{receiver}).to receive :#{method_name}"
+        body = ["expect(#{receiver}).to have_received :#{method_name}"]
+        test_context << TestComponent::Test.new("calls #{receiver}.#{method_name}", body)
+      end
+
+      private
+
+      def receiver
+        code[1].value
+      end
+
+      def method_name
+        code[2]
+      end
+    end
+  end
+end

data/lib/code_driven_development/rule/set.rb

@@ -0,0 +1,29 @@
+module CodeDrivenDevelopment
+  module Rule
+    class Set
+      def initialize(*rules, default: nil)
+        @rules = rules
+        @default_rule = default
+      end
+
+      def test_for(code, test_context)
+        capable_rules = rules.map do |klass|
+          klass.new(code, self, test_context)
+        end.select(&:capable?)
+
+        case capable_rules.count
+        when 0
+          default_rule.new(code, self, test_context).test
+        when 1
+          capable_rules.first.test
+        else
+          raise "Multiple rules matched #{code.inspect}:\n\t" + capable_rules.map(&:class).map(&:to_s).join("\n\t")
+        end
+      end
+
+      private
+
+      attr_reader :rules, :default_rule
+    end
+  end
+end

data/lib/code_driven_development/rule/validation.rb

@@ -0,0 +1,33 @@
+module CodeDrivenDevelopment
+  module Rule
+    class Validation < AbstractRule
+      def capable?
+        code.sexp_type == :call &&
+          code.sexp_body[0].nil? &&
+          code.sexp_body[1] == :validate
+      end
+
+      def test
+        test_context << TestComponent::OneLineTest.new("should validate_#{type}_of :#{field}")
+      end
+
+      private
+
+      def field
+        extract_symbol(code[3])
+      end
+
+      def type
+        extract_symbol(extract_hash_key(code[-1]))
+      end
+
+      def extract_symbol(literal)
+        literal[1]
+      end
+
+      def extract_hash_key(hash)
+        hash[1]
+      end
+    end
+  end
+end

data/lib/code_driven_development/test_component/blank_slate.rb

@@ -0,0 +1,19 @@
+module CodeDrivenDevelopment
+  module TestComponent
+    class BlankSlate
+      def initialize
+        @children = []
+      end
+
+      def indented_output(io = IndentedOutput.new)
+        @children.map do |child|
+          child.indented_output(io)
+        end.join
+      end
+
+      def << child
+        @children << child
+      end
+    end
+  end
+end

data/lib/code_driven_development/test_component/context.rb

@@ -0,0 +1,32 @@
+module CodeDrivenDevelopment
+  module TestComponent
+    class Context
+      def initialize(description = nil, befores = [], tests = [])
+        @description, @befores, @tests = description, befores, tests
+      end
+
+      attr_reader :tests, :befores
+      attr_accessor :description
+
+      def << child
+        @tests << child
+      end
+
+      def indented_output io
+        io << ""
+        io << "describe #@description do"
+        io.indented do
+          if befores.any?
+            io << "before do"
+            io.indented do
+              befores.each { |before| io << before }
+            end
+            io << "end"
+          end
+          tests.each { |test| test.indented_output(io) }
+        end
+        io << "end"
+      end
+    end
+  end
+end

data/lib/code_driven_development/test_component/one_line_test.rb

@@ -0,0 +1,15 @@
+module CodeDrivenDevelopment
+  module TestComponent
+    class OneLineTest
+      def initialize(body = "")
+        @body = body
+      end
+
+      attr_accessor :body
+
+      def indented_output(io)
+        io << "it { #@body }"
+      end
+    end
+  end
+end

data/lib/code_driven_development/test_component/test.rb

@@ -0,0 +1,19 @@
+module CodeDrivenDevelopment
+  module TestComponent
+    class Test
+      def initialize(description = "", body = "")
+        @description, @body = description, body
+      end
+
+      attr_accessor :description, :body
+
+      def indented_output io
+        io << "it \"#@description\" do"
+        io.indented do
+          body.each { |line| io << line }
+        end
+        io << "end"
+      end
+    end
+  end
+end

data/lib/code_driven_development/version.rb

@@ -0,0 +1,3 @@
+module CodeDrivenDevelopment
+  VERSION = "0.0.1"
+end

data/lib/code_driven_development.rb

@@ -0,0 +1,18 @@
+require 'ruby_parser'
+
+require "code_driven_development/version"
+require "code_driven_development/code_driven_development"
+require "code_driven_development/indented_output"
+
+require "code_driven_development/test_component/test"
+require "code_driven_development/test_component/one_line_test"
+require "code_driven_development/test_component/context"
+require "code_driven_development/test_component/blank_slate"
+
+require "code_driven_development/rule/abstract_rule"
+require "code_driven_development/rule/set"
+require "code_driven_development/rule/method_call"
+require "code_driven_development/rule/default"
+require "code_driven_development/rule/class"
+require "code_driven_development/rule/validation"
+require "code_driven_development/rule/instance_method"

data/samples/validations.rb

@@ -0,0 +1,13 @@
+class Bunker < ActiveRecord::Base
+  validate :password, secure: true
+  validate :location, :protected => true
+
+  def alert_staff
+    Staff.alert_all
+  end
+
+  def alert_president
+    SecretService.stand_down
+    President.alert
+  end
+end

data/spec/my_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe CodeDrivenDevelopment::CodeDrivenDevelopment do
+  before do
+    implementation = <<-EOT
+      class Lolcat < ActiveRecord::Base
+        validate :cuteness, presence: true
+
+        def i_call_things
+          CentralBureaucracy.file_report
+        end
+      end
+    EOT
+
+    @test = CodeDrivenDevelopment::CodeDrivenDevelopment.new(implementation).test_code
+  end
+
+  it "puts the model name in the describe description" do
+    expect(@test).to match /^describe Lolcat do/
+  end
+
+  it "includes shoulda-matchers for simple validations" do
+    expect(@test).to match /^\tit.*should.*validate_presence_of.*:cuteness/
+  end
+
+  it "stubs out method calls" do
+    expect(@test).to have_consecutive_lines_matching [
+      /^\tdescribe.*"#i_call_things"/,
+      /^\t\tbefore/,
+      /^\t\t\tallow.CentralBureaucracy..to.*receive.*:file_report/,
+      /^\t\t\tdescribed_class.new.i_call_things/,
+      /^\t\tit.*calls Central.*do/,
+      /^\t\t\texpect.CentralBureaucracy..to.*have_received.*:file_report/
+    ]
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require_relative '../lib/code_driven_development'
+require_relative 'support/have_consecutive_lines_matching_matcher'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+end

data/spec/support/have_consecutive_lines_matching_matcher.rb

@@ -0,0 +1,29 @@
+RSpec::Matchers.define :have_consecutive_lines_matching do |*regexen|
+  def compute_match(string, regexen)
+    if regexen.empty?
+      return [true]
+    end
+
+    regex = regexen.shift
+    m = string.match(regex)
+    if m
+      remaining = m.post_match
+      newline_i = remaining.index("\n")+1
+      remaining = remaining[newline_i..-1]
+      compute_match(remaining, regexen)
+    else
+      return [false, regex, string]
+    end
+  end
+
+  match do |actual|
+    compute_match(actual, regexen.flatten).shift
+  end
+
+  failure_message_for_should do |actual|
+    _, failed_regex, failed_string = compute_match(actual, regexen.flatten)
+    "expected #{failed_regex.inspect} to match #{failed_string.inspect}"
+  end
+
+  diffable
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: code_driven_development
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dan Finnie
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby_parser
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: 'TOddddd: Write a gem description'
+email:
+- dan@danfinnie.com
+executables:
+- cdd
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/cdd
+- code-driven-development.gemspec
+- lib/code_driven_development.rb
+- lib/code_driven_development/code_driven_development.rb
+- lib/code_driven_development/indented_output.rb
+- lib/code_driven_development/rule/abstract_rule.rb
+- lib/code_driven_development/rule/class.rb
+- lib/code_driven_development/rule/default.rb
+- lib/code_driven_development/rule/instance_method.rb
+- lib/code_driven_development/rule/method_call.rb
+- lib/code_driven_development/rule/set.rb
+- lib/code_driven_development/rule/validation.rb
+- lib/code_driven_development/test_component/blank_slate.rb
+- lib/code_driven_development/test_component/context.rb
+- lib/code_driven_development/test_component/one_line_test.rb
+- lib/code_driven_development/test_component/test.rb
+- lib/code_driven_development/version.rb
+- samples/validations.rb
+- spec/my_spec.rb
+- spec/spec_helper.rb
+- spec/support/have_consecutive_lines_matching_matcher.rb
+homepage: ''
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: 'TOddddd: Write a gem summary'
+test_files:
+- spec/my_spec.rb
+- spec/spec_helper.rb
+- spec/support/have_consecutive_lines_matching_matcher.rb