sinatra-mvc 0.0.3 → 0.0.4

data/README.md

@@ -40,7 +40,7 @@ operating systems might be added later.
 Installing
 ----------
 
-Installing Sinatra MVC is reasonably simple. All you need is Mercurial,
+Installing Sinatra MVC is reasonably simple. All you need is Ruby Gems,
 some development headers (distributed by your operating system) and
 a terminal.
 
@@ -128,7 +128,8 @@ For a Rubygems installation simply run:
 
     # gem update
 
-To get the latest updates from the repository, just pull (and merge if needed).
+To get the latest updates from the repository, just pull (and merge if
+needed).
 
     $ cd $HOME/src/sinatra-mvc
     $ hg pull
@@ -184,6 +185,11 @@ the name of the file in the `translations` directory, without the `.yml`
 file extension. Just like `views_root`, `translations` is a subdirectory
 of your project.
 
+The development server socket can be configured using the `port` and `bind`
+options. These determine the TCP port and the listen address of the
+development server. These will be ignored when you're using the rackup file
+to run your server (i.e. any other method than running `sinatra-mvc`).
+
 The database connection is defined by `database_connection`.  The value is
 a string, following the syntax:
 
@@ -357,12 +363,12 @@ Some sidemarks with this selection of templating solutions:
   for now.
 
 Normally, you have to do weird stuff in Sinatra like using
-`:'directory/my_view.erubis'` for rendering views in sub directories. Sinatra
-MVC has added automatic view prefixes. The former method of using hardcoded
-prefixes still works, but now there's URI-based mapping as well. In short,
-it uses the views from the directory path in the view directory if that
-path matches the URI prefix. For example, if you have a controller like
-this:
+`:'directory/my_view.erubis'` for rendering views in sub directories.
+Sinatra MVC has added automatic view prefixes. The former method of using
+hardcoded prefixes still works, but now there's URI-based mapping as well.
+In short, it uses the views from the directory path in the view directory
+if that path matches the URI prefix. For example, if you have a controller
+like this:
 
     get '/my/little/pony/pink'
       erubis :pink
@@ -434,8 +440,8 @@ defined in your `models` directory. If you just want to migrate your models
 
 This will only update the tables in such a way it can't modify any of the
 data already present. To do that, you'll have to write migrations. This
-functionality is lacking at the moment. Datamapper is able to run migrations,
-but nobody bothered documenting how they work.
+functionality is lacking at the moment. Datamapper is able to run
+migrations, but nobody bothered documenting how they work.
 
 Internationalisation
 --------------------
@@ -459,6 +465,55 @@ To run a script, simply call:
     $ cd my_project
     $ sinatra-mvc <scriptname without .rb>
 
+Tests
+-----
+
+Since version 0.0.4 tests are intergrated into Sinatra MVC. If you
+value stability in an application, tests are an awesome way to meet that
+goal. [`Rack::Test`][18] is used to define and run tests on your
+application.
+
+The Sinatra DSL is augmented by a test function. This fuction works as a
+skeleton to house your tests. This function also tracks your test coverage.
+When testing, the output will tell you if you've covered all your code
+with tests. The method it uses is reading the defined controller paths, and
+matching that with the defined tests. It's recommended to define the tests
+in the same file as the actual code. If you don't like this approach for
+what ever reason, a separate `app/tests` directory will do as well.
+
+Here's an example:
+
+    get '/horse/:name' do |name|
+      "Hello horsey! Hello #{h name}!"
+    end
+    
+    test '/horse/:name' do
+      def test_horse_name
+        get '/horse/pwny'
+        assert_equal last_response.body, 'Hello horsey! Hello pwny!'
+      end
+    end
+
+Within the `test '/path' do ... end` body you can use all of the Rack::Test
+functionality you normally use in standard tests. The same gotchas apply
+here. All of the test functions have to have the `test_` prefix. Test
+functions should be unique. All of the Sinatra MVC test function bodies
+share a single scope.
+
+At the moment automatic test coverage reporting does not understand the
+difference between HTTP methods. You'll have to make sure to test all of
+the methods that use the same path yourself. In the future Sinatra MVC
+will track your `Rack::Test` usage as well, to provide a complete test
+coverage report.
+
+Running the tests is easy. Just run:
+
+    $ cd ~/src/my_project
+    $ sinatra-mvc test
+
+The `--verbose` flag shows more information about the running tests. All
+the `Rack::Test` command line flags are also supported and used.
+
 Single Character Reserved Variables
 -----------------------------------
 
@@ -469,12 +524,12 @@ Just don't use these as variables within controllers and views, mkay?
 * `c - ` Conditional form field.
 * `n - ` Just meaning "n" of something.
 
-[1]: http://rubydoc.info/gems/sinatra/1.1.0/file/README.rdoc#Views___Templates
+[1]: http://www.sinatrarb.com/intro#Views%20/%20Templates
 [2]: http://rtomayko.github.com/shotgun/
 [3]: http://www.modrails.com/
 [4]: http://heroku.com/
-[5]: http://www.rubydoc.info/gems/sinatra/1.1.0/file/README.rdoc#Application_Class_Scope
-[6]: http://www.rubydoc.info/gems/sinatra/1.1.0/file/README.rdoc
+[5]: http://www.sinatrarb.com/intro#Application/Class%20Scope
+[6]: http://www.sinatrarb.com/intro
 [7]: http://rubydoc.info/gems/dm-core/1.0.2/frames
 [8]: https://github.com/jorrizza/sinatra-mvc
 [9]: https://bitbucket.org/jorrizza/sinatra-mvc
@@ -484,4 +539,5 @@ Just don't use these as variables within controllers and views, mkay?
 [14]: http://www.rubydoc.info/gems/dm-validations/1.0.2/frames
 [15]: http://www.sinatrarb.com/configuration.html
 [16]: http://r18n.rubyforge.org/sinatra.html
-[17]: http://gembundler.com/man/gemfile.5.html
+[17]: http://gembundler.com/man/gemfile.5.html
+[18]: https://github.com/brynary/rack-test

data/bin/sinatra-mvc

@@ -3,6 +3,10 @@
 # Determine the location of our project
 PROJECT = ENV['PROJECT'] ? ENV['PROJECT'] : '.'
 
+# We have to make sure the environment variable RACK_ENV is set
+# to "test" when we're actually testing.
+ENV['RACK_ENV'] = 'test' if ARGV[0] == 'test'
+
 Dir.chdir PROJECT do
   require 'sinatra-mvc'
 

data/lib/sinatra-mvc.rb

@@ -13,8 +13,7 @@ Encoding.default_external = 'UTF-8'
 # Project include path.
 $:.push PROJECT
 
-# Guess what. We need these.
-require 'rubygems'
+# Guess what. We need this.
 require 'sinatra/base'
 
 # Load all of the core modules, in order.
@@ -29,6 +28,7 @@ require 'sinatra-mvc/flash_messages'
 require 'sinatra-mvc/post_handler'
 require 'sinatra-mvc/conditional_form_field'
 require 'sinatra-mvc/escaping'
+require 'sinatra-mvc/testing'
 
 # We use Bundler to manage the rest of the deps.
 require 'bundler/setup'
@@ -37,4 +37,5 @@ require 'bundler/setup'
 require 'conf/environment'
 require 'sinatra-mvc/database_connection'
 require 'sinatra-mvc/load_app'
+require 'sinatra-mvc/do_tests'
 require 'sinatra-mvc/load_utils'

data/lib/sinatra-mvc/do_tests.rb

@@ -0,0 +1,48 @@
+# Run tests if the user calls sinatra-mvc test.
+
+if ENV['RACK_ENV'] == 'test' && !defined? RACKUP
+  puts '>> Running unit tests using Rack::Test'
+  require 'test/unit'
+  require 'rack/test'
+
+  class SinatraMVC
+    # A general test case class for SinatraMVC.
+    class UnitTest < Test::Unit::TestCase
+      include Rack::Test::Methods
+      
+      def app
+        ::SinatraMVC
+      end
+    end
+  end
+
+  # Add every test defined in our project to the unit test.
+  SinatraMVC.tests.each do |t|
+    SinatraMVC::UnitTest.class_exec &t
+  end
+
+  # Because test/unit is just a MiniTest shell, we can cheat a bit
+  # here to start the tests.
+  MiniTest::Unit.new.run(ARGV)
+
+  # Print out the test coverage.
+  verbose = ARGV.include? '--verbose'
+  number_of_calls = 0
+  number_of_tests = 0
+  puts "\n>> Verbose test coverage:" if verbose
+  SinatraMVC.test_coverage.each do |method, calls|
+    puts "  #{method.to_s.upcase}" if verbose && calls.count > 0
+    calls.keys.sort.each do |call|
+      test_written = calls[call]
+      number_of_calls += 1
+      number_of_tests += 1 if test_written
+
+      puts "    #{call}: #{test_written ? 'Yes' : 'No'}" if verbose
+    end
+  end
+  puts ">> Test coverage: #{number_of_tests}/#{number_of_calls}"
+  
+  # We don't want to start the server, now do we?
+  puts '>> Done testing'
+  exit
+end

data/lib/sinatra-mvc/testing.rb

@@ -0,0 +1,73 @@
+class SinatraMVC
+  class << self
+    @@tests = []
+    @@test_paths = []
+
+    # Override get, put, post and delete to track test coverage.
+    @@controller_calls = {}
+    [:get, :put, :post, :delete].each do |method|
+      @@controller_calls[method] = []
+    end
+
+    # Wrapper for tracking Sinatra::Base#get calls.
+    def get(path, opts={}, &block)
+      @@controller_calls[:get] << path
+      
+      super path, opts, &block
+    end
+    
+    # Wrapper for tracking Sinatra::Base#put calls.
+    def put(path, opts={}, &block)
+      @@controller_calls[:put] << path
+      
+      super path, opts, &block
+    end
+    
+    # Wrapper for tracking Sinatra::Base#post calls.
+    def post(path, opts={}, &block)
+      @@controller_calls[:post] << path
+      
+      super path, opts, &block
+    end
+    
+    # Wrapper for tracking Sinatra::Base#delete calls.
+    def delete(path, opts={}, &block)
+      @@controller_calls[:delete] << path
+      
+      super path, opts, &block
+    end
+    
+    # A test block within SinatraMVC will do nothing.
+    # It only stores the block for use when we're actually testing.
+    def test(path = nil, &block)
+      if test?
+        @@tests << block
+        @@test_paths << path
+      end
+    end
+
+    # Returns an array of test blocks if in testing mode.
+    def tests
+      if test?
+        @@tests
+      end
+    end
+
+    # Returns a test coverage report if in testing mode.
+    # TODO: track individual tests for HTTP methods in Rack::Test.
+    def test_coverage
+      if test?
+        coverage = {}
+
+        @@controller_calls.each do |method, calls|
+          tests_done = calls.map do |call|
+            @@test_paths.include?(call)
+          end
+          coverage[method] = Hash[*calls.zip(tests_done).flatten]
+        end
+
+        coverage
+      end
+    end
+  end
+end

data/lib/sinatra-mvc/view_prefix.rb

@@ -5,7 +5,7 @@ class SinatraMVC
   # mode, in which set() could be called in the request scope.
   before do |obj|
     obj.class.class_exec request do |request|
-      first_dir = request.env['REQUEST_URI'].split('/')[1]
+      first_dir = request.path_info.split('/')[1]
 
       if first_dir
         if File.directory? File.join(settings.views_root, first_dir)

data/skel/Gemfile

@@ -21,3 +21,6 @@ gem 'erubis'
 # gem 'RedCloth'
 # gem 'liquid'
 # gem 'less'
+
+# When testing, uncomment this.
+# gem 'rack-test'

data/skel/conf/environment.rb

@@ -7,5 +7,6 @@ require 'dm-migrations'
 
 # Templating Engines
 require 'erubis'
+#require 'rdiscount'
 #require 'redcloth'
 #require 'liquid'

data/skel/conf/settings.yml

@@ -14,5 +14,9 @@ public: public
 default_locale: en
 translations: i18n
 
+# Default server config. Not used when using the Rackup file.
+port: 4567
+bind: 0.0.0.0
+
 # Database
 database_connection: mysql://sinatra:sinatra@localhost/sinatra_mvc

data/skel/views/docs.md

@@ -40,7 +40,7 @@ operating systems might be added later.
 Installing
 ----------
 
-Installing Sinatra MVC is reasonably simple. All you need is Mercurial,
+Installing Sinatra MVC is reasonably simple. All you need is Ruby Gems,
 some development headers (distributed by your operating system) and
 a terminal.
 
@@ -128,7 +128,8 @@ For a Rubygems installation simply run:
 
     # gem update
 
-To get the latest updates from the repository, just pull (and merge if needed).
+To get the latest updates from the repository, just pull (and merge if
+needed).
 
     $ cd $HOME/src/sinatra-mvc
     $ hg pull
@@ -184,6 +185,11 @@ the name of the file in the `translations` directory, without the `.yml`
 file extension. Just like `views_root`, `translations` is a subdirectory
 of your project.
 
+The development server socket can be configured using the `port` and `bind`
+options. These determine the TCP port and the listen address of the
+development server. These will be ignored when you're using the rackup file
+to run your server (i.e. any other method than running `sinatra-mvc`).
+
 The database connection is defined by `database_connection`.  The value is
 a string, following the syntax:
 
@@ -357,12 +363,12 @@ Some sidemarks with this selection of templating solutions:
   for now.
 
 Normally, you have to do weird stuff in Sinatra like using
-`:'directory/my_view.erubis'` for rendering views in sub directories. Sinatra
-MVC has added automatic view prefixes. The former method of using hardcoded
-prefixes still works, but now there's URI-based mapping as well. In short,
-it uses the views from the directory path in the view directory if that
-path matches the URI prefix. For example, if you have a controller like
-this:
+`:'directory/my_view.erubis'` for rendering views in sub directories.
+Sinatra MVC has added automatic view prefixes. The former method of using
+hardcoded prefixes still works, but now there's URI-based mapping as well.
+In short, it uses the views from the directory path in the view directory
+if that path matches the URI prefix. For example, if you have a controller
+like this:
 
     get '/my/little/pony/pink'
       erubis :pink
@@ -434,8 +440,8 @@ defined in your `models` directory. If you just want to migrate your models
 
 This will only update the tables in such a way it can't modify any of the
 data already present. To do that, you'll have to write migrations. This
-functionality is lacking at the moment. Datamapper is able to run migrations,
-but nobody bothered documenting how they work.
+functionality is lacking at the moment. Datamapper is able to run
+migrations, but nobody bothered documenting how they work.
 
 Internationalisation
 --------------------
@@ -459,6 +465,55 @@ To run a script, simply call:
     $ cd my_project
     $ sinatra-mvc <scriptname without .rb>
 
+Tests
+-----
+
+Since version 0.0.4 tests are intergrated into Sinatra MVC. If you
+value stability in an application, tests are an awesome way to meet that
+goal. [`Rack::Test`][18] is used to define and run tests on your
+application.
+
+The Sinatra DSL is augmented by a test function. This fuction works as a
+skeleton to house your tests. This function also tracks your test coverage.
+When testing, the output will tell you if you've covered all your code
+with tests. The method it uses is reading the defined controller paths, and
+matching that with the defined tests. It's recommended to define the tests
+in the same file as the actual code. If you don't like this approach for
+what ever reason, a separate `app/tests` directory will do as well.
+
+Here's an example:
+
+    get '/horse/:name' do |name|
+      "Hello horsey! Hello #{h name}!"
+    end
+    
+    test '/horse/:name' do
+      def test_horse_name
+        get '/horse/pwny'
+        assert_equal last_response.body, 'Hello horsey! Hello pwny!'
+      end
+    end
+
+Within the `test '/path' do ... end` body you can use all of the Rack::Test
+functionality you normally use in standard tests. The same gotchas apply
+here. All of the test functions have to have the `test_` prefix. Test
+functions should be unique. All of the Sinatra MVC test function bodies
+share a single scope.
+
+At the moment automatic test coverage reporting does not understand the
+difference between HTTP methods. You'll have to make sure to test all of
+the methods that use the same path yourself. In the future Sinatra MVC
+will track your `Rack::Test` usage as well, to provide a complete test
+coverage report.
+
+Running the tests is easy. Just run:
+
+    $ cd ~/src/my_project
+    $ sinatra-mvc test
+
+The `--verbose` flag shows more information about the running tests. All
+the `Rack::Test` command line flags are also supported and used.
+
 Single Character Reserved Variables
 -----------------------------------
 
@@ -469,12 +524,12 @@ Just don't use these as variables within controllers and views, mkay?
 * `c - ` Conditional form field.
 * `n - ` Just meaning "n" of something.
 
-[1]: http://rubydoc.info/gems/sinatra/1.1.0/file/README.rdoc#Views___Templates
+[1]: http://www.sinatrarb.com/intro#Views%20/%20Templates
 [2]: http://rtomayko.github.com/shotgun/
 [3]: http://www.modrails.com/
 [4]: http://heroku.com/
-[5]: http://www.rubydoc.info/gems/sinatra/1.1.0/file/README.rdoc#Application_Class_Scope
-[6]: http://www.rubydoc.info/gems/sinatra/1.1.0/file/README.rdoc
+[5]: http://www.sinatrarb.com/intro#Application/Class%20Scope
+[6]: http://www.sinatrarb.com/intro
 [7]: http://rubydoc.info/gems/dm-core/1.0.2/frames
 [8]: https://github.com/jorrizza/sinatra-mvc
 [9]: https://bitbucket.org/jorrizza/sinatra-mvc
@@ -484,4 +539,5 @@ Just don't use these as variables within controllers and views, mkay?
 [14]: http://www.rubydoc.info/gems/dm-validations/1.0.2/frames
 [15]: http://www.sinatrarb.com/configuration.html
 [16]: http://r18n.rubyforge.org/sinatra.html
-[17]: http://gembundler.com/man/gemfile.5.html
+[17]: http://gembundler.com/man/gemfile.5.html
+[18]: https://github.com/brynary/rack-test

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Joris van Rooij
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-12 00:00:00 +01:00
+date: 2011-02-23 00:00:00 +01:00
 default_executable: sinatra-mvc
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -187,6 +187,8 @@ files:
 - lib/sinatra-mvc/view_prefix.rb
 - lib/sinatra-mvc/settings.rb
 - lib/sinatra-mvc/conditional_form_field.rb
+- lib/sinatra-mvc/testing.rb
+- lib/sinatra-mvc/do_tests.rb
 - lib/sinatra-mvc.rb
 - skel/.hgignore
 - skel/.gitignore