paloma 1.2.6 → 2.0.0

data/lib/paloma/generators/setup_generator.rb

@@ -2,7 +2,6 @@ module Paloma
   #
   # rails g paloma:setup
   #   - Generates the following:
-  #     - 'paloma' folder under app/assets/javascripts/
   #     - index.js and paloma.js under the 'paloma' folder
   #
   # Generated Files:
@@ -18,11 +17,22 @@ module Paloma
     source_root Paloma.templates
     
     def setup_paloma
+      locals_js = "#{Paloma.destination}/_locals.js"
+      filters_js = "#{Paloma.destination}/_filters.js"
       index_js = "#{Paloma.destination}/index.js"
-      paloma_js = "#{Paloma.destination}/paloma.js"
-      
-      copy_file 'index.js', index_js unless File.exists?(index_js)
-      copy_file 'paloma.js', paloma_js unless File.exists?(paloma_js)
+
+
+      copy_file './application/_locals.js', locals_js unless File.exists?(locals_js)   
+      copy_file './index.js', index_js unless File.exists?(index_js)
+
+
+      unless File.exists?(filters_js)
+        content = File.read("#{Paloma.templates}/_filters.js")
+        content.gsub!(':scope', '/')
+
+        File.open(filters_js, 'w'){ |f| f.write(content) }
+        puts "create #{filters_js}"
+      end
     end
   end
 end

data/lib/paloma/rails/controller_generator.rb

@@ -0,0 +1,11 @@
+module ::Rails::Generators
+  class ControllerGenerator < NamedBase 
+
+    class_option :paloma, :type => :boolean, :default => true
+
+    def paloma
+      invoke 'paloma:add', ([file_name] + actions) if options[:paloma]
+    end
+
+  end
+end

data/lib/paloma/rails/engine.rb

@@ -0,0 +1,6 @@
+module Paloma
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/paloma.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'paloma'
-  s.version     = '1.2.6'
+  s.version     = '2.0.0'
   s.summary     = "Provides an easy way to execute page-specific javascript for Rails."
   s.description = "Page-specific javascript for Rails done right"
   s.authors     = ["Karl Paragua", "Bia Esmero"]
@@ -12,10 +12,8 @@ Gem::Specification.new do |s|
   
   s.add_development_dependency 'rails', ['>= 3.1.0']
   s.add_development_dependency 'rake', ['>= 0']
-  s.add_development_dependency 'sqlite3', ['>= 0']
   s.add_development_dependency 'rspec', ['>= 0']
   s.add_development_dependency 'rspec-rails', ['~> 2.0']
   s.add_development_dependency 'generator_spec', ['~> 0.8.7']
   s.add_development_dependency 'capybara', ['>= 1.0']
-  s.add_development_dependency 'database_cleaner', ['>= 0']
 end

data/spec/test_app/.gitignore

@@ -0,0 +1,15 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+
+# Ignore bundler config
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp

data/spec/test_app/.rspec

@@ -0,0 +1 @@
+--color

data/spec/test_app/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec :path => '../../'

data/spec/test_app/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.

data/spec/test_app/Rakefile

@@ -0,0 +1,16 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec:generators') do |spec|
+  spec.pattern = FileList['spec/generators/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new('spec:javascripts') do |spec|
+  spec.pattern = FileList['spec/javascripts/*_spec.rb']
+end
+
+TestApp::Application.load_tasks

data/spec/test_app/app/assets/javascripts/application.js

@@ -0,0 +1,16 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require paloma
+//= require_tree .

data/spec/test_app/app/assets/javascripts/paloma/_filters.js

@@ -0,0 +1,130 @@
+// For testing only
+window.filtersExecuted = window.filtersExecuted || {before : [], after : []};
+
+
+(function(){ 
+  var filter = new Paloma.FilterScope('/');
+  var _x = Paloma.variableContainer;
+
+
+  // To-Be-Skipped Before Filters
+  filter.as('Standard Skip Before Filter').before_all().perform(function(params){
+    filtersExecuted.before.push('Standard Skip Before Filter');
+  });
+  
+  filter.as('Only Skip Before Filter').before_all().perform(function(params){
+    filtersExecuted.before.push('Only Skip Before Filter');
+  });
+
+  filter.as('Except Skip Before Filter').before_all().perform(function(params){
+    filtersExecuted.before.push('Except Skip Before Filter');
+  });
+
+
+  // To-Be-Skipped After Filters
+  filter.as('Standard Skip After Filter').after_all().perform(function(params){
+    filtersExecuted.after.push('Standard Skip After Filter');
+  });
+  
+  filter.as('Only Skip After Filter').after_all().perform(function(params){
+    filtersExecuted.after.push('Only Skip After Filter');
+  });
+
+  filter.as('Except Skip After Filter').after_all().perform(function(params){
+    filtersExecuted.after.push('Except Skip After Filter');
+  });
+
+
+  // To-Be-Skipped Around Filters
+  filter.as('Standard Skip Around Filter').around_all().perform(function(params){
+    var execution = window.callback ? 'after' : 'before';
+    filtersExecuted[execution].push('Standard Skip Around Filter');
+  });
+  
+  filter.as('Only Skip Around Filter').around_all().perform(function(params){
+    var execution = window.callback ? 'after' : 'before';
+    filtersExecuted[execution].push('Only Skip Around Filter');
+  });
+
+  filter.as('Except Skip Around Filter').around_all().perform(function(params){
+    var execution = window.callback ? 'after' : 'before';
+    filtersExecuted[execution].push('Except Skip Around Filter');
+  });
+
+
+
+  // Before
+  filter.as('Application Standard Before').
+  before('basic_action', 'another_basic_action').
+  perform(function(params)
+  {
+    filtersExecuted.before.push('Application Standard Before');
+  });
+  
+  
+  filter.as('Application Before All').
+  before_all().perform(function(params)
+  {
+    filtersExecuted.before.push('Application Before All');
+  });
+  
+  
+  filter.as('Application Except Before').
+  except_before('basic_action').
+  perform(function(params)
+  {
+    filtersExecuted.before.push('Application Except Before');
+  });
+  
+  
+  // After
+  filter.as('Application Standard After').
+  after('basic_action', 'another_basic_action').
+  perform(function(params)
+  {
+    filtersExecuted.after.push('Application Standard After');
+  });
+  
+  
+  filter.as('Application After All').
+  after_all().perform(function(params)
+  {
+    filtersExecuted.after.push('Application After All');
+  });
+  
+  
+  filter.as('Application Except After').
+  except_after('basic_action').
+  perform(function(params)
+  {
+    filtersExecuted.after.push('Application Except After');
+  });
+  
+  
+  // Around
+  filter.as('Application Standard Around').
+  around('basic_action', 'another_basic_action').
+  perform(function(params)
+  {
+    var execution = window.callback ? 'after' : 'before';
+    filtersExecuted[execution].push('Application Standard Around');
+  });
+  
+  
+  filter.as('Application Around All').
+  around_all().perform(function(params)
+  {
+    var execution = window.callback ? 'after' : 'before';
+    filtersExecuted[execution].push('Application Around All');
+  });
+  
+  
+  filter.as('Application Except Around').
+  except_around('basic_action').
+  perform(function(params)
+  {
+    var execution = window.callback ? 'after' : 'before';
+    filtersExecuted[execution].push('Application Except Around');
+  });
+  
+})();