carlosbrando-remarkable 0.0.99 → 2.2.1

data/History.txt

@@ -1,6 +1,6 @@
-== 1.0.0 2008-11-12
+* 2.2.0
+  * Added support to ALL ActiveRecord validations
+  * Some code refactoring to simplify Remarkable Base
 
-* 1 major enhancement:
-  * Initial release
-  * All macros of Shoulda have been ported to RSpec.
-	* Two syntaxes of macros have been added: Shoulda and RSpec.
+* 2.1.5
+  * Added new method should_render_page_with_metadata with tests

data/Manifest.txt

@@ -5,51 +5,61 @@ README.rdoc
 Rakefile
 init.rb
 lib/remarkable.rb
+lib/remarkable/active_record/README.markdown
 lib/remarkable/active_record/active_record.rb
 lib/remarkable/active_record/helpers.rb
-lib/remarkable/active_record/macros/associations/belong_to.rb
-lib/remarkable/active_record/macros/associations/have_and_belong_to_many.rb
-lib/remarkable/active_record/macros/associations/have_many.rb
-lib/remarkable/active_record/macros/associations/have_one.rb
-lib/remarkable/active_record/macros/database/have_db_column.rb
-lib/remarkable/active_record/macros/database/have_db_columns.rb
-lib/remarkable/active_record/macros/database/have_indices.rb
-lib/remarkable/active_record/macros/validations/allow_values_for.rb
-lib/remarkable/active_record/macros/validations/ensure_length_at_least.rb
-lib/remarkable/active_record/macros/validations/ensure_length_in_range.rb
-lib/remarkable/active_record/macros/validations/ensure_length_is.rb
-lib/remarkable/active_record/macros/validations/ensure_value_in_range.rb
-lib/remarkable/active_record/macros/validations/have_class_methods.rb
-lib/remarkable/active_record/macros/validations/have_instance_methods.rb
-lib/remarkable/active_record/macros/validations/have_named_scope.rb
-lib/remarkable/active_record/macros/validations/have_readonly_attributes.rb
-lib/remarkable/active_record/macros/validations/only_allow_numeric_values_for.rb
-lib/remarkable/active_record/macros/validations/protect_attributes.rb
-lib/remarkable/active_record/macros/validations/require_acceptance_of.rb
-lib/remarkable/active_record/macros/validations/require_attributes.rb
-lib/remarkable/active_record/macros/validations/require_unique_attributes.rb
+lib/remarkable/active_record/macros.rb
+lib/remarkable/active_record/macros/associations/association_matcher.rb
+lib/remarkable/active_record/macros/callbacks/callback_matcher.rb
+lib/remarkable/active_record/macros/database/column_matcher.rb
+lib/remarkable/active_record/macros/database/index_matcher.rb
+lib/remarkable/active_record/macros/validations/allow_mass_assignment_of_matcher.rb
+lib/remarkable/active_record/macros/validations/ensure_value_in_list_matcher.rb
+lib/remarkable/active_record/macros/validations/ensure_value_in_range_matcher.rb
+lib/remarkable/active_record/macros/validations/have_class_methods_matcher.rb
+lib/remarkable/active_record/macros/validations/have_instance_methods_matcher.rb
+lib/remarkable/active_record/macros/validations/have_named_scope_matcher.rb
+lib/remarkable/active_record/macros/validations/have_readonly_attributes_matcher.rb
+lib/remarkable/active_record/macros/validations/protect_attributes_matcher.rb
+lib/remarkable/active_record/macros/validations/validate_acceptance_of_matcher.rb
+lib/remarkable/active_record/macros/validations/validate_associated_matcher.rb
+lib/remarkable/active_record/macros/validations/validate_confirmation_of_matcher.rb
+lib/remarkable/active_record/macros/validations/validate_exclusion_of_matcher.rb
+lib/remarkable/active_record/macros/validations/validate_format_of_matcher.rb
+lib/remarkable/active_record/macros/validations/validate_inclusion_of_matcher.rb
+lib/remarkable/active_record/macros/validations/validate_length_of_matcher.rb
+lib/remarkable/active_record/macros/validations/validate_numericality_of_matcher.rb
+lib/remarkable/active_record/macros/validations/validate_presence_of_matcher.rb
+lib/remarkable/active_record/macros/validations/validate_uniqueness_of_matcher.rb
+lib/remarkable/assertions.rb
+lib/remarkable/controller/README.markdown
 lib/remarkable/controller/controller.rb
 lib/remarkable/controller/helpers.rb
-lib/remarkable/controller/macros/assign_to.rb
-lib/remarkable/controller/macros/filter_params.rb
-lib/remarkable/controller/macros/redirect_to.rb
-lib/remarkable/controller/macros/render_a_form.rb
-lib/remarkable/controller/macros/render_template.rb
-lib/remarkable/controller/macros/render_with_layout.rb
-lib/remarkable/controller/macros/respond_with.rb
-lib/remarkable/controller/macros/respond_with_content_type.rb
-lib/remarkable/controller/macros/return_from_session.rb
-lib/remarkable/controller/macros/route.rb
-lib/remarkable/controller/macros/set_the_flash_to.rb
+lib/remarkable/controller/macros.rb
+lib/remarkable/controller/macros/assign_matcher.rb
+lib/remarkable/controller/macros/filter_params_matcher.rb
+lib/remarkable/controller/macros/metadata_matcher.rb
+lib/remarkable/controller/macros/render_with_layout_matcher.rb
+lib/remarkable/controller/macros/respond_with_content_type_matcher.rb
+lib/remarkable/controller/macros/respond_with_matcher.rb
+lib/remarkable/controller/macros/return_from_session_matcher.rb
+lib/remarkable/controller/macros/route_matcher.rb
+lib/remarkable/controller/macros/set_the_flash_to_matcher.rb
+lib/remarkable/dsl.rb
 lib/remarkable/example/example_methods.rb
+lib/remarkable/helpers.rb
+lib/remarkable/matcher_base.rb
 lib/remarkable/private_helpers.rb
+lib/remarkable/rails.rb
 rails/init.rb
+remarkable.gemspec
 script/console
 script/destroy
 script/generate
 spec/controllers/posts_controller_spec.rb
 spec/controllers/users_controller_spec.rb
 spec/fixtures/addresses.yml
+spec/fixtures/fleas.yml
 spec/fixtures/friendships.yml
 spec/fixtures/posts.yml
 spec/fixtures/products.yml
@@ -65,6 +75,9 @@ spec/models/product_spec.rb
 spec/models/tag_spec.rb
 spec/models/tagging_spec.rb
 spec/models/user_spec.rb
+spec/other/custom_macros_spec.rb
+spec/other/my_own_matcher_spec.rb
+spec/other/private_helpers_spec.rb
 spec/rails_root/app/controllers/application.rb
 spec/rails_root/app/controllers/posts_controller.rb
 spec/rails_root/app/controllers/users_controller.rb
@@ -72,9 +85,9 @@ spec/rails_root/app/helpers/application_helper.rb
 spec/rails_root/app/helpers/posts_helper.rb
 spec/rails_root/app/helpers/users_helper.rb
 spec/rails_root/app/models/address.rb
-spec/rails_root/app/models/dog.rb
 spec/rails_root/app/models/flea.rb
 spec/rails_root/app/models/friendship.rb
+spec/rails_root/app/models/pets/dog.rb
 spec/rails_root/app/models/post.rb
 spec/rails_root/app/models/product.rb
 spec/rails_root/app/models/tag.rb
@@ -94,9 +107,10 @@ spec/rails_root/app/views/users/show.rhtml
 spec/rails_root/config/boot.rb
 spec/rails_root/config/database.yml
 spec/rails_root/config/environment.rb
-spec/rails_root/config/environments/sqlite3.rb
+spec/rails_root/config/environments/test.rb
 spec/rails_root/config/initializers/new_rails_defaults.rb
 spec/rails_root/config/initializers/shoulda.rb
+spec/rails_root/config/locales/en.yml
 spec/rails_root/config/routes.rb
 spec/rails_root/db/migrate/001_create_users.rb
 spec/rails_root/db/migrate/002_create_posts.rb
@@ -108,16 +122,20 @@ spec/rails_root/db/migrate/007_create_fleas.rb
 spec/rails_root/db/migrate/008_create_dogs_fleas.rb
 spec/rails_root/db/migrate/009_create_products.rb
 spec/rails_root/db/migrate/010_create_friendships.rb
+spec/rails_root/db/migrate/011_add_fleas_color.rb
+spec/rails_root/db/migrate/012_add_fleas_address.rb
 spec/rails_root/db/schema.rb
 spec/rails_root/log/.keep
-spec/rails_root/log/sqlite3.log
+spec/rails_root/log/test.log
 spec/rails_root/public/.htaccess
 spec/rails_root/public/404.html
 spec/rails_root/public/422.html
 spec/rails_root/public/500.html
 spec/rails_root/script/console
 spec/rails_root/script/generate
+spec/rails_root/spec/remarkable_macros/.keep
 spec/rails_root/vendor/plugins/.keep
+spec/rails_root/vendor/plugins/my_plugin/remarkable_macros/.keep
 spec/rcov.opts
 spec/spec.opts
 spec/spec_helper.rb

data/PostInstall.txt

@@ -1,7 +1,2 @@
 
-For more information on remarkable, see http://remarkable.rubyforge.org
-
-NOTE: Change this information in PostInstall.txt 
-You can also delete it if you don't want it.
-
-
+For more information on remarkable, see http://remarkable.nomedojogo.com

data/README.rdoc

@@ -1,32 +1,126 @@
-= remarkable
+= Simplifying tests!
 
-* http://www.nomedojogo.com
+Remarkable is a framework for Rspec matchers.
 
-== DESCRIPTION:
+Matchers are a powerful tool for DRYing and simplifying tests and if you are using Rspec on Rails, you are already using them for a long long time (redirect_to and be_success for example).
 
-FIX (describe your package)
+But the creation of matchers should not be in hand of few, but spreaded to millions. :)
 
-== FEATURES/PROBLEMS:
+If not enough, Remarkable also makes easy your matchers become macros and have even cleaner tests.
 
-* FIX (list of features or problems)
+== Current Features
 
-== SYNOPSIS:
+Here are some of the things that make Remarkable special (and we are working on even more):
 
-  FIX (code sample of usage)
+* <b>All</b> ActiveRecord validation macros with support to <b>all</b> options;
+* More Rails macros (all currently Shoulda macros are ported);
+* It has two different test syntaxes: one for those who like the RSpec style and another for those who like macro (Shoulda) style;
+* It's a gem;
+* Tests;
+* More tests;
+* And a few more tests.
 
-== REQUIREMENTS:
+Unlike other similar projects, Remarkable is the only one that tests itself, and this is a big difference, believe me!
 
-* FIX (list of requirements)
+How can we trust in a project that has no tests? How do you ensure that the last commit didn't break anything?
 
-== INSTALL:
+== Synopsis
 
-* FIX (sudo gem install, anything else)
+All Remarkable macros can be accessed in two different ways. For those who prefer the Shoulda style, let’s look at some model tests:
 
-== LICENSE:
+  describe Post do
+    fixtures :all
+
+    should_belong_to :user
+    should_belong_to :owner
+    should_belong_to :user, :owner
+
+    should_have_many :tags, :through => :taggings
+    should_have_many :through_tags, :through => :taggings
+    should_have_many :tags, :through_tags, :through => :taggings
+
+    should_validate_uniqueness_of :title
+    should_validate_presence_of :body, :message => /wtf/
+    should_validate_presence_of :title
+    should_validate_numericality_of :user_id
+  end
+
+Notice how you declare your macros with the same name as you do in Rails! This is great because most of the time you won't have to check the documentation (just pay attention that <tt>has_many</tt> becomes <tt>have_many</tt> and <tt>validates</tt> become <tt>validate</tt> according to english grammar).
+
+The syntax above is similar with Shoulda, but those who likes more the Rspec way can simply do:
+
+  describe Post do
+    fixtures :all
+
+    it { should belong_to(:user) }
+    it { should belong_to(:owner) }
+    it { should belong_to(:user, :owner) }
+
+    it { should have_many(:tags, :through => :taggings) }
+    it { should have_many(:through_tags, :through => :taggings) }
+    it { should have_many(:tags, :through_tags, :through => :taggings) }
+
+    it { should validate_uniqueness_of(:title) }
+    it { should validate_presence_of(:body, :message => /wtf/) }
+    it { should validate_presence_of(:title) }
+    it { should validate_numericality_of(:user_id) }
+  end
+
+== Macros
+
+=== Here are all the available macros:
+
+ActiveRecord macros: http://wiki.github.com/carlosbrando/remarkable/active-record-macros
+
+Controller macros: http://wiki.github.com/carlosbrando/remarkable/controller-macros
+
+=== Pending Macros
+
+Even more than just bringing macros to Rspec, we are bringing Rspec to macros. So let's suppose you are doing some code refactoring and you know some tests will fail while you clean the house, what do you do then?
+
+In Rspec you could do:
+
+  xit { should validate_numericality_of(:user_id) }
+
+Well, now you can do just the same with macros:
+
+  xvalidate_numericality_of(:user_id)
+
+And it's even better, because it will show a nice message:
+
+  "Example disabled: should validate numericality of user_id"
+
+Yeah!
+
+== Install
+
+Run the following if you haven't already:
+
+  gem sources -a http://gems.github.com
+
+Install the gem:
+
+  sudo gem install carlosbrando-remarkable
+
+In RAILS_ROOT/config/environment.rb:
+
+  config.gem "carlosbrando-remarkable", :lib => "remarkable", :source => "http://gems.github.com"
+
+== Requirements
+
+* rspec >= 1.1.12
+* rspec-rails >= 1.1.12
+
+== More information
+
+Google group: http://groups.google.com/group/remarkable-core
+Bug tracking: http://carlosbrando.lighthouseapp.com/projects/19775-remarkable/overview
+
+== License
 
 (The MIT License)
 
-Copyright (c) 2008 FIXME full name
+Copyright (c) 2008 Carlos Brando
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -45,4 +139,4 @@ 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.
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -1,29 +1,29 @@
-%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
-require File.dirname(__FILE__) + '/lib/remarkable'
-
-# Generate all the Rake tasks
-# Run 'rake -T' to see list of generated tasks (from gem root directory)
-$hoe = Hoe.new('remarkable', Remarkable::VERSION) do |p|
-  p.developer('Carlos Brando', 'eduardobrando@gmail.com')
-  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
-  p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
-  p.rubyforge_name       = p.name # TODO this is default value
-  p.extra_deps         = [
-    ['rspec','>= 1.1.11'],
-    ['rspec-rails','>= 1.1.11']
-  ]
-  p.extra_dev_deps = [
-    ['newgem', ">= #{::Newgem::VERSION}"]
-  ]
-  
-  p.clean_globs |= %w[**/.DS_Store tmp *.log]
-  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
-  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
-  p.rsync_args = '-av --delete --ignore-errors'
-end
-
-require 'newgem/tasks' # load /tasks/*.rake
-Dir['tasks/**/*.rake'].each { |t| load t }
-
-# TODO - want other tests/tasks run by default? Add them to the list
-task :default => [:spec, :features]
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/remarkable'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('remarkable', Remarkable::VERSION) do |p|
+  p.developer('Carlos Brando', 'eduardobrando@gmail.com')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  p.rubyforge_name       = p.name # TODO this is default value
+  p.extra_deps         = [
+    ['rspec','>= 1.1.12'],
+    ['rspec-rails','>= 1.1.12']
+  ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+task :default => [:spec, :features]