neverfails 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+*.swp
+*.pyc
+*.egg-info
+build/
+dist/
+

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/HISTORY.md

@@ -0,0 +1,8 @@
+v0.0.1
+======
+
+New Features
+------------
+
+* First working version
+

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011
+
+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,287 @@
+Behavior-driven development (BDD) consists of [five steps](http://cukes.info/):
+
+1. Describe behavior in plain text
+2. Write a step definition
+3. Run and watch it fail
+4. Write code to make the step pass
+5. Run again and see the step pass
+
+Neverfails is a proof of concept to reduce this list to **two steps**:
+
+1. Describe behaviour in plain text
+2. Run and watch it pass
+
+With neverfails, step definitions do not simply check whether the existing code satifies the required behaviour or not. They also **write the code** to make them pass.
+
+Neverfails involves an ambitious idea: code generation based on specifications. This idea does not depend on a specific platform or programming language. In principle, it could be implemented with any framework. The current claudiob/neverfails@rails branch uses Rails as a web framework and Ruby as the programming language. The master claudiob/neverfails@master branch, on the other hand, is investigating the same approach using Python and Django.
+
+Behavior-driven development in Rails
+====================================
+
+Before approaching neverfails, it is important to understand how Behaviour-Driven Development (BDD) typically takes place within a Rails project.
+
+Step 1 (Describe behavior in plain text)
+----------------------------------------
+
+Say we want to create a web store for a *grocery* store, with a distinct page for each product. The *apples* page, for instance, will list the types and quantities of apples currently in store, showing "No apples left" if there are none left in the market. This scenario can be described as:
+
+``` cucumber
+Feature: Apples
+  Scenario: No apples left
+    Given there are no apples
+    When I browse the list of apples
+    Then I should see the text "No apples left"
+```
+
+Having described behavior in plain text, we create a blank Rails project and make use of [cucumber](https://github.com/gabrielfalcao/lettuce) and [capybara](https://github.com/jnicklas/capybara) to run the steps.
+
+The following commands set up a new `grocery` Rails project with a basic SQLite database, and a bundle installation with cucumber and capybara:
+
+``` bash
+rails new grocery -JT
+cd grocery
+rm public/index.html
+rm public/images/rails.png
+echo -e '\ngem "cucumber"' >> Gemfile
+echo -e '\ngem "cucumber-rails"' >> Gemfile
+bundle install
+rails g cucumber:install
+echo "require 'cucumber/rails'
+Capybara.default_selector = :css
+ActionController::Base.allow_rescue = false" >| features/support/env.rb
+sed -i '' -e's/<<: \*test/<<: *development/' config/database.yml
+rake db:create
+echo -e "Feature: Apples
+Scenario: No apples left
+    Given there are no apples
+    When I browse the list of apples
+    Then I should see the text \"No apples left\"
+" > features/apples.feature
+```
+
+Step 2 (Write step definitions)
+-------------------------------
+
+To make Rails aware of what the actions in the scenario actually mean, we can either write new step definitions, or import some library that translates common actions into Python commands. One such popular library for Web applications is [capybara](https://github.com/jnicklas/capybara).
+
+For the sake of the `grocery` example, we define the three steps of the `No apples left` scenario as follows:
+
+* *Given there are no apples*: this step passes if a model called 'Apple' exist and if there are no instances of this model in the database
+* *When I browse the list of apples*: this step passes if a page exists listing apples and if I can open that page in a browser
+* *Then I should see the text "No apples left"*: this step passes if I see the text "No apples left" in that page
+
+The file `fails_steps.rb` in this package contains these definition in Ruby and capybara code. 
+
+Step 3 (Run and watch it fail)
+------------------------------
+
+The following commands copy the content of this file in the project and run the steps again:
+
+``` bash
+echo -e "# MODELS
+
+Given /^there are no (\\S+?)\$/ do |objects|
+  model_name = objects.classify
+  Given \"there is a model called #{model_name}\"
+  Given \"there are no instances of that model\"
+end
+
+Given /^(?:|there is )a model called (.+?)\$/ do |model_name|
+  assert ActiveRecord::Base.connection.tables.include?(model_name.tableize), 
+    \"No model found called #{model_name}\"
+  @last_model = model_name.constantize
+end
+
+Given /^(?:|there are )no instances of that model\$/ do
+  @last_model.delete_all
+end
+
+# NAVIGATION
+
+When /^I browse the list of (.+?)\$/ do |models|
+  Given \"there is a page listing #{models}\"
+  When \"I navigate to that page\"
+end
+
+Given /^there is a page listing (.+?)\$/ do |models|
+  Given \"there is a page with URL /#{models}\"
+end
+
+Given /^there is a page with URL (.+?)\$/ do |url|
+  assert Rails.application.routes.routes.collect(&:conditions).
+    collect{|route| route[:path_info] =~ url }.any?, 
+    \"No URL pattern found matching #{url}\"
+  \$last_url = url
+end
+
+When /^I navigate to that page\$/ do 
+  visit \$last_url
+end
+
+# CONTENT
+
+Then /^I should see the text \"([^\"]*)\"\$/ do |text|
+  begin
+    page.should have_content(text)
+  rescue Test::Unit::AssertionFailedError => e
+    raise e.class, \"The text \\\"#{text}\\\" was not found in the current page\"
+  end  
+end
+" > features/step_definitions/fails_steps.rb
+cucumber RAILS_ENV=development
+```
+
+The result is the following, indicating that the *first* step has failed:
+
+```
+No model found called Apple. (Test::Unit::AssertionFailedError)
+```
+
+Step 4 (Write code to make the three steps pass)
+-------------------------------------------------    
+    
+To make the first step pass, we need to create an Apple model and store it in the database:
+
+``` bash
+rails g model apple             
+rake db:migrate
+cucumber RAILS_ENV=development
+```
+
+The result is now the following, indicating that the *second* step has failed:
+
+```
+No URL pattern found matching /apples. (Test::Unit::AssertionFailedError)
+```
+
+To make the second step pass, we need to create a URL pattern matching "apples/" that points to a blank HTML page:
+
+``` bash
+rails g controller Apples index
+sed -i '' '  
+/get "apples\/index"/ a\
+    match "/apples" => "apples#index"
+' config/routes.rb
+cucumber RAILS_ENV=development
+```
+
+The result is now the following, indicating that the *third* step has failed:
+
+```
+The text "No apples" left was not found in the current page (Test::Unit::AssertionFailedError)
+```
+
+To make the third step pass, we need to add the text "No apples left" to the page that lists apples:
+
+``` bash
+echo "No apples left" >| app/views/apples/index.html.erb
+cucumber RAILS_ENV=development
+```
+
+Step 5 (Run again and see the step pass)
+----------------------------------------
+
+Finally, the three steps pass and running them again returns the message:
+
+``` cucumber
+Feature: Apples
+  Scenario: No apples left
+    Given there are no apples
+    When I browse the list of apples
+    Then I should see the text "No apples left"
+    
+1 feature (1 passed)
+3 steps (3 passed)
+```
+
+Neverfails does all of this, so you don't have to (TO COMPLETE)
+===============================================================
+
+The `grocery` example shows that Behaviour-Driven Development is time-consuming even for very small applications, with an empty model and a view showing one sentence. 
+Time is spent watching the tests fail and writing snippets of code that are common to every web application (creating a model, filling view with text and so on).
+
+Neverfails reduces this time by automatically creating the missing snippets of code when a step fails. 
+
+
+Step 1 (Describe behavior in plain text)
+----------------------------------------
+
+Continuing with the grocery example, say we want to add this new scenario:
+
+``` cucumber
+Feature: Bananas
+  Scenario: No bananas left
+    Given there are no bananas
+    When I browse the list of bananas
+    Then I should see the text "No bananas left"
+```
+
+The following commands add the previous scenario to the grocery project and include neverfails to the project:
+
+``` bash
+echo -e "Feature: Bananas\n\tScenario: No bananas left\n\t\tGiven there are no bananas\n\t\tWhen I browse the list of bananas\n\t\tThen I should see the text \"No bananas left\"" > features/bananas.feature
+echo -e '\ngem "neverfails"' >> Gemfile
+bundle install
+echo -e "\nrequire 'neverfails'" >> features/support/env.rb
+echo -e "\nRails.configuration.cache_classes = false" >> features/support/env.rb
+```
+
+Step 2 (Run and watch it pass)
+------------------------------
+
+Both the `apples` and the `bananas` scenario can be run with the command:
+
+``` bash
+cucumber features/
+```
+
+The `apples` scenario passes since we already wrote all its required. The `bananas` scenario, though, passes as well:
+
+``` cucumber
+Feature: Apples
+  Scenario: No apples left
+    Given there are no apples
+    When I browse the list of apples
+    Then I should see the text "No apples left"
+
+Feature: Bananas
+  Scenario: No bananas left
+    Given there are no bananas
+Creating tables ...
+Creating table bananas_banana
+Installing custom SQL ...
+Installing indexes ...
+    When I browse the list of bananas
+    Then I should see the text "No bananas left"
+      
+2 features (2 passed)
+2 scenarios (2 passed)
+6 steps (6 passed)
+```
+
+How neverfails works
+====================
+
+With neverfails, all the steps are parsed by cucumber as normal. However, if a step fails, neverfails *does not* raise an AssertionError but runs the code to make the step pass, then runs the step again. 
+
+So far, neverfails is only able to recognize the three kinds of step included in the `grocery` sample project: creating a model, creating a view, adding text to that view. This is why I call neverfails a proof of concept. If other people find this project interesting (or if I get more time to work on this), then neverfails will grow up to the point where people with no programming experience will be able to create complex web applications by describing what they wish for.
+
+
+Installing neverfails
+=====================
+
+To follow the example described above, you need [rails](https://github.com/rails/rails) and [bundler](http://gembundler.com) installed on your machine.
+The following commands will install these packages, given you already have Ruby installed with [rubygems](http://rubygems.org) enabled:
+
+``` bash
+gem install rails
+gem install bundler
+```
+
+The actual neverfails gem can either be downloaded from GitHub or installed by adding the following to the Rails project's Gemfile:
+
+    gem 'neverfails'
+
+and the running:
+
+    bundle install

data/TODO.md

@@ -0,0 +1,9 @@
+Bugs
+----
+
+* Because of @@missing_view_file, the third match will fail if the second has not been executed in the same execution
+
+Improvements
+------------
+
+* Don't use class and global variables ($last_url, @@missing_view_file)

data/fails_steps.rb

@@ -0,0 +1,49 @@
+# MODELS
+  
+Given /^there are no (\S+?)$/ do |objects|
+  model_name = objects.classify
+  Given "there is a model called #{model_name}"
+  Given "there are no instances of that model"
+end
+
+Given /^(?:|there is )a model called (.+?)$/ do |model_name|
+  assert ActiveRecord::Base.connection.tables.include?(model_name.tableize), 
+    "No model found called #{model_name}"
+  @last_model = model_name.constantize
+end
+
+Given /^(?:|there are )no instances of that model$/ do
+  @last_model.delete_all
+end
+
+# NAVIGATION
+
+When /^I browse the list of (.+?)$/ do |models|
+  Given "there is a page listing #{models}"
+  When "I navigate to that page"
+end
+
+Given /^there is a page listing (.+?)$/ do |models|
+  Given "there is a page with URL /#{models}/index"
+end
+
+Given /^there is a page with URL (.+?)$/ do |url|
+  assert Rails.application.routes.routes.collect(&:conditions).
+    collect{|route| route[:path_info] =~ url }.any?, 
+    "No URL pattern found matching #{url}"
+  $last_url = url
+end
+
+When /^I navigate to that page$/ do 
+  visit $last_url
+end
+
+# CONTENT
+
+Then /^I should see the text "([^"]*)"$/ do |text|
+  begin
+    assert_contain text
+  rescue Test::Unit::AssertionFailedError => e
+    raise e.class, "The text \"#{text}\" was not found in the current page"
+  end  
+end

data/lib/neverfails.rb

@@ -0,0 +1,60 @@
+require 'rails/generators'
+
+module Cucumber
+  class StepMatch
+    def invoke_with_neverfails(multiline_arg)
+      begin
+        invoke_without_neverfails(multiline_arg)
+      rescue Exception => e # NOTE: Test::Unit::AssertionFailedError
+        match1 = /No model found called (.+?)\.$/.match(e.message)
+        match2 = /No URL pattern found matching \/(.+?)\.$/.match(e.message)
+        match3 = /The text "(.+?)" was not found in the current page$/.match(e.message)
+        if match1
+          create_missing_model match1[1]
+        elsif match2
+          create_missing_page_listing match2[1]
+        elsif match3
+          create_missing_text match3[1]
+        else
+          raise
+        end
+        return invoke_without_neverfails(multiline_arg) # Try again
+      end
+    end
+
+    alias_method_chain :invoke, :neverfails
+
+  end
+end
+
+def create_missing_model(singular_name)
+  # Generate the model and the migration
+  Rails::Generators.invoke("model", [singular_name, "--orm=active_record", "--migration"])
+  # Run the migration
+  ActiveRecord::Migrator.migrate "db/migrate/"
+end
+
+def create_missing_page_listing(objects)
+  # Generate the controller
+  require 'ruby-debug'
+  debugger
+  Rails::Generators.invoke("controller", [objects.classify, "index"])
+  # Add an extra route match "/models" => "model#index"
+  singular = objects.singularize
+  @@missing_view_file = "app/views/#{singular}/index.html.erb"
+  routes_file = 'config/routes.rb'
+  old_routes = File.read(routes_file)
+  File.open(routes_file, "w") do |file| 
+    file.puts old_routes.gsub(/get "#{singular}\/index"/, 
+    "get \"#{singular}/index\"\nmatch \"/#{objects}\" => \"#{singular}#index\"")
+  end      
+  # Reload routes
+  ::Rails.application.reload_routes!
+end
+
+def create_missing_text(text)
+  File.open(@@missing_view_file, "w") do |file| 
+    file.puts "#{text}\n"
+  end
+  Capybara.current_session.visit $last_url
+end

data/neverfails.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'neverfails'
+  s.version     = '0.0.1'
+  s.authors       = ["Claudio B."]
+  s.email         = ["claudiob@gmail.com"]
+  s.homepage      = "https://github.com/claudiob/neverfails/tree/rails"
+  s.summary       = %q{Cucumber plugin that generates code to make failing steps pass}
+  s.description   = %q{With neverfails, step definitions do not simply check whether the existing code satifies the required behaviour or not. They also write the code to make them pass.}
+  s.licenses      = ["MIT"]
+
+  s.add_dependency 'cucumber'
+  s.add_dependency 'cucumber-rails'
+
+  s.files            = `git ls-files`.split("\n")
+  s.test_files       = `git ls-files -- {spec,features}/*`.split("\n")
+  s.executables      = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_path     = "lib"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification 
+name: neverfails
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Claudio B.
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-07 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: cucumber-rails
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: With neverfails, step definitions do not simply check whether the existing code satifies the required behaviour or not. They also write the code to make them pass.
+email: 
+- claudiob@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- HISTORY.md
+- MIT-LICENSE
+- README.md
+- TODO.md
+- fails_steps.rb
+- lib/neverfails.rb
+- neverfails.gemspec
+has_rdoc: true
+homepage: https://github.com/claudiob/neverfails/tree/rails
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Cucumber plugin that generates code to make failing steps pass
+test_files: []
+